Describing Adiabatic conditions

Collaboration diagram for Describing Adiabatic conditions:

Namespaces
	aspect::AdiabaticConditions

Classes
class	aspect::AdiabaticConditions::Interface< dim >

Macros
#define	ASPECT_REGISTER_ADIABATIC_CONDITIONS_MODEL(classname, name, description)

Functions
template<int dim>
void	aspect::AdiabaticConditions::register_adiabatic_conditions (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(*factory_function)())
template<int dim>
std::unique_ptr< Interface< dim > >	aspect::AdiabaticConditions::create_adiabatic_conditions (ParameterHandler &prm)
template<int dim>
void	aspect::AdiabaticConditions::declare_parameters (ParameterHandler &prm)

Detailed Description

A group for all things that have to do with adiabatic reference profiles.

Macro Definition Documentation

ASPECT_REGISTER_ADIABATIC_CONDITIONS_MODEL

#define ASPECT_REGISTER_ADIABATIC_CONDITIONS_MODEL	(		classname,
			name,
			description
	)

Value:

template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_ADIABATIC_CONDITIONS_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::AdiabaticConditions::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::AdiabaticConditions::register_adiabatic_conditions<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::AdiabaticConditions::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::AdiabaticConditions::register_adiabatic_conditions<3>, \
                                name, description); \
  }

Given a class name, a name, and a description for the parameter file for a adiabatic conditions model, register it with the functions that can declare their parameters and create these objects.

Definition at line 210 of file interface.h.

Function Documentation

register_adiabatic_conditions()

template<int dim>

void aspect::AdiabaticConditions::register_adiabatic_conditions	(	const std::string &	name,
		const std::string &	description,
		void(*)(ParameterHandler &)	declare_parameters_function,
		std::unique_ptr< Interface< dim >>(*)()	factory_function
	)

Register a adiabatic conditions model so that it can be selected from the parameter file.

Parameters

name	A string that identifies the adiabatic conditions model
description	A text description of what this model does and that will be listed in the documentation of the parameter file.
declare_parameters_function	A pointer to a function that can be used to declare the parameters that this model wants to read from input files.
factory_function	A pointer to a function that can create an object of this adiabatic conditions model.

create_adiabatic_conditions()

template<int dim>

std::unique_ptr<Interface<dim> > aspect::AdiabaticConditions::create_adiabatic_conditions

(

ParameterHandler &

prm

)

A function that given the name of a model returns a pointer to an object that describes it. Ownership of the pointer is transferred to the caller.

The model object returned is not yet initialized and has not read its runtime parameters yet.

declare_parameters()

template<int dim>

void aspect::AdiabaticConditions::declare_parameters

(

ParameterHandler &

prm

)

Declare the runtime parameters of the registered adiabatic conditions model.

Referenced by aspect::internal::Plugins::PluginList< InterfaceClass >::get_description_string(), and aspect::internal::Plugins::RegisterHelper< InterfaceClass, ModelClass >::RegisterHelper().