Describing initial conditions for compositional fields

Collaboration diagram for Describing initial conditions for compositional fields:

Namespaces
	aspect::InitialComposition

Classes
class	aspect::InitialComposition::Interface< dim >
class	aspect::InitialComposition::Manager< dim >

Macros
#define	ASPECT_REGISTER_INITIAL_COMPOSITION_MODEL(classname, name, description)

Functions
template<int dim>
std::string	aspect::InitialComposition::get_valid_model_names_pattern ()

Detailed Description

A module for the definition of functions and classes that have to do with initial conditions for the composition.

Macro Definition Documentation

ASPECT_REGISTER_INITIAL_COMPOSITION_MODEL

#define ASPECT_REGISTER_INITIAL_COMPOSITION_MODEL	(		classname,
			name,
			description
	)

Value:

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

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

Definition at line 266 of file interface.h.

Function Documentation

get_valid_model_names_pattern()

template<int dim>

std::string aspect::InitialComposition::get_valid_model_names_pattern

(

)

Return a string that consists of the names of initial composition models that can be selected. These names are separated by a vertical line '|' so that the string can be an input to the deal.II classes Patterns::Selection or Patterns::MultipleSelection.

Referenced by aspect::InitialComposition::Manager< dim >::get_matching_initial_composition_model().