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

Public Member Functions

virtual ~Interface ()
 
virtual void initialize ()
 
virtual double initial_composition (const Point< dim > &position, const unsigned int n_comp) const =0
 
virtual void parse_parameters (ParameterHandler &prm)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Detailed Description

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

A base class for parameterizations of initial conditions.

Definition at line 116 of file simulator_access.h.

Constructor & Destructor Documentation

§ ~Interface()

template<int dim>
virtual aspect::InitialComposition::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::InitialComposition::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::InitialComposition::AsciiData< dim >.

§ initial_composition()

template<int dim>
virtual double aspect::InitialComposition::Interface< dim >::initial_composition ( const Point< dim > &  position,
const unsigned int  n_comp 
) const
pure virtual

§ declare_parameters()

template<int dim>
static void aspect::InitialComposition::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::InitialComposition::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::InitialComposition::AsciiData< dim >, and aspect::InitialComposition::Function< dim >.


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