ASPECT
Public Member Functions | List of all members
aspect::BoundaryComposition::Interface< dim > Class Template Referenceabstract
Describing boundary conditions » Describing boundary conditions for compositional fields
Inheritance diagram for aspect::BoundaryComposition::Interface< dim >:
Inheritance graph
[legend]

Public Member Functions

virtual double boundary_composition (const types::boundary_id boundary_indicator, const Point< dim > &position, const unsigned int compositional_field) const =0
 
- Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
 
virtual void initialize ()
 
virtual void update ()
 
virtual void parse_parameters (ParameterHandler &prm)
 

Additional Inherited Members

- Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
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 88 of file simulator_access.h.

Member Function Documentation

§ 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
pure 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.

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

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