![]() |
ASPECT
|
Static Public Member Functions | |
static void | declare_parameters (ParameterHandler &prm) |
static void | register_initial_composition (const std::string &name, const std::string &description, void(*declare_parameters_function)(ParameterHandler &), std::unique_ptr< Interface< dim >>(*factory_function)()) |
static void | write_plugin_graph (std::ostream &output_stream) |
![]() | |
static void | get_composition_values_at_q_point (const std::vector< std::vector< double >> &composition_values, const unsigned int q, std::vector< double > &composition_values_at_q_point) |
Private Attributes | |
std::list< std::unique_ptr< Interface< dim > > > | initial_composition_objects |
std::vector< std::string > | model_names |
std::vector< aspect::Utilities::Operator > | model_operators |
A class that manages all initial composition objects.
Definition at line 104 of file simulator_access.h.
|
override |
Destructor. Made virtual since this class has virtual member functions.
|
static |
Declare the parameters of all known initial composition plugins, as well as of ones this class has itself.
void aspect::InitialComposition::Manager< dim >::parse_parameters | ( | ParameterHandler & | prm | ) |
Read the parameters this class declares from the parameter file. This determines which initial composition objects will be created; then let these objects read their parameters as well.
double aspect::InitialComposition::Manager< dim >::initial_composition | ( | const Point< dim > & | position, |
const unsigned int | n_comp | ||
) | const |
A function that calls the initial_composition functions of all individual initial composition objects for the composition given by n_comp
, and adds up the values of the individual calls.
|
static |
A function that is used to register initial composition objects in such a way that the Manager can deal with all of them without having to know them by name. This allows the files in which individual plugins are implemented to register these plugins, rather than also having to modify the Manager class by adding the new initial composition plugin class.
name | A string that identifies the initial composition 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 initial composition model wants to read from input files. |
factory_function | A pointer to a function that can create an object of this initial composition model. |
const std::vector<std::string>& aspect::InitialComposition::Manager< dim >::get_active_initial_composition_names | ( | ) | const |
Return a list of names of all initial composition models currently used in the computation, as specified in the input file.
const std::list<std::unique_ptr<Interface<dim> > >& aspect::InitialComposition::Manager< dim >::get_active_initial_composition_conditions | ( | ) | const |
Return a list of pointers to all initial composition models currently used in the computation, as specified in the input file.
|
inline |
Go through the list of all initial composition models that have been selected in the input file (and are consequently currently active) and return true if one of them has the desired type specified by the template argument.
Definition at line 256 of file interface.h.
|
inline |
Go through the list of all initial composition models that have been selected in the input file (and are consequently currently active) and see if one of them has the type specified by the template argument or can be casted to that type. If so, return a reference to it. If no initial composition model is active that matches the given type, throw an exception.
Definition at line 269 of file interface.h.
References aspect::InitialComposition::get_valid_model_names_pattern().
|
static |
For the current plugin subsystem, write a connection graph of all of the plugins we know about, in the format that the programs dot and neato understand. This allows for a visualization of how all of the plugins that ASPECT knows about are interconnected, and connect to other parts of the ASPECT code.
output_stream | The stream to write the output to. |
aspect::InitialComposition::Manager< dim >::DeclException1 | ( | ExcInitialCompositionNameNotFound | , |
std::string | |||
) |
Exception.
|
private |
A list of initial composition objects that have been requested in the parameter file.
Definition at line 233 of file interface.h.
|
private |
A list of names of initial composition objects that have been requested in the parameter file.
Definition at line 239 of file interface.h.
|
private |
A list of enums of initial composition operators that have been requested in the parameter file. Each entry is used to modify the initial compositional field with the values from the associated plugin in model_names.
Definition at line 247 of file interface.h.