ASPECT
Public Member Functions | Static Public Member Functions | List of all members
aspect::BoundaryComposition::Interface< dim > Class Template Reference
Inheritance diagram for aspect::BoundaryComposition::Interface< dim >:
Inheritance graph
[legend]

Public Member Functions

virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual double boundary_composition (const types::boundary_id boundary_indicator, const Point< dim > &position, const unsigned int compositional_field) const
 
virtual void parse_parameters (ParameterHandler &prm)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Detailed Description

template<int dim>
class aspect::BoundaryComposition::Interface< dim >

Base class for classes that describe composition boundary values.

Definition at line 99 of file simulator_access.h.

Constructor & Destructor Documentation

§ ~Interface()

template<int dim>
virtual aspect::BoundaryComposition::Interface< dim >::~Interface ( )
virtual

Destructor. Made virtual to enforce that derived classes also have virtual destructors.

Member Function Documentation

§ initialize()

template<int dim>
virtual void aspect::BoundaryComposition::Interface< dim >::initialize ( )
virtual

Initialization function. This function is called once at the beginning of the program after parse_parameters is run and after the SimulatorAccess (if applicable) is initialized.

Reimplemented in aspect::BoundaryComposition::Box< dim >, aspect::BoundaryComposition::TwoMergedBoxes< dim >, and aspect::BoundaryComposition::AsciiData< dim >.

§ update()

template<int dim>
virtual void aspect::BoundaryComposition::Interface< dim >::update ( )
virtual

A function that is called at the beginning of each time step. The default implementation of the function does nothing, but derived classes that need more elaborate setups for a given time step may overload the function.

The point of this function is to allow complex boundary composition models to do an initialization step once at the beginning of each time step. An example would be a model that needs to call an external program to compute composition changes at sides.

Reimplemented in aspect::BoundaryComposition::AsciiData< dim >, and aspect::BoundaryComposition::Function< dim >.

§ boundary_composition()

template<int dim>
virtual double aspect::BoundaryComposition::Interface< dim >::boundary_composition ( const types::boundary_id  boundary_indicator,
const Point< dim > &  position,
const unsigned int  compositional_field 
) const
virtual

Return the composition that is to hold at a particular position on the boundary of the domain.

Parameters
boundary_indicatorThe boundary indicator of the part of the boundary of the domain on which the point is located at which we are requesting the composition.
positionThe position of the point at which we ask for the composition.
compositional_fieldThe index of the compositional field between 0 and parameters.n_compositional_fields.
Returns
Boundary value of the compositional field compositional_field at the position position.

Reimplemented in aspect::BoundaryComposition::AsciiData< dim >, aspect::BoundaryComposition::SphericalConstant< dim >, aspect::BoundaryComposition::Function< dim >, aspect::BoundaryComposition::InitialComposition< dim >, aspect::BoundaryComposition::Box< dim >, and aspect::BoundaryComposition::TwoMergedBoxes< dim >.

§ declare_parameters()

template<int dim>
static void aspect::BoundaryComposition::Interface< dim >::declare_parameters ( ParameterHandler prm)
static

Declare the parameters this class takes through input files. The default implementation of this function does not describe any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.

§ parse_parameters()

template<int dim>
virtual void aspect::BoundaryComposition::Interface< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters this class declares from the parameter file. The default implementation of this function does not read any parameters. Consequently, derived classes do not have to overload this function if they do not take any runtime parameters.

Reimplemented in aspect::BoundaryComposition::AsciiData< dim >, aspect::BoundaryComposition::SphericalConstant< dim >, aspect::BoundaryComposition::Function< dim >, aspect::BoundaryComposition::InitialComposition< dim >, aspect::BoundaryComposition::Box< dim >, and aspect::BoundaryComposition::TwoMergedBoxes< dim >.


The documentation for this class was generated from the following files: