aspect::GravityModel::Interface< dim > Class Template Reference

Inheritance diagram for aspect::GravityModel::Interface< dim >:

Public Member Functions
virtual	~Interface ()=default
virtual void	initialize ()
virtual Tensor< 1, dim >	gravity_vector (const Point< dim > &position) const =0
virtual void	update ()
virtual void	parse_parameters (ParameterHandler &prm)

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)

Detailed Description

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

A base class for parameterizations of gravity models.

Definition at line 55 of file simulator_access.h.

Constructor & Destructor Documentation

~Interface()

template<int dim>

virtual aspect::GravityModel::Interface< dim >::~Interface ( )

virtualdefault

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

Member Function Documentation

initialize()

template<int dim>

virtual void aspect::GravityModel::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::GravityModel::RadialEarthLike< dim >, and aspect::GravityModel::AsciiData< dim >.

gravity_vector()

template<int dim>

virtual Tensor<1,dim> aspect::GravityModel::Interface< dim >::gravity_vector ( const Point< dim > &  position ) const

pure virtual

Return the gravity vector as a function of position.

Implemented in aspect::GravityModel::RadialLinear< dim >, aspect::GravityModel::RadialEarthLike< dim >, aspect::GravityModel::AsciiData< dim >, aspect::GravityModel::Function< dim >, aspect::GravityModel::RadialConstant< dim >, and aspect::GravityModel::Vertical< dim >.

update()

template<int dim>

virtual void aspect::GravityModel::Interface< dim >::update ( )

virtual

A function that is called at the beginning of each time step and that allows the implementation to update internal data structures. This is useful, for example, if you have a gravity model that depends on time, or if you have a gravity model that depends on the solution of the previous step.

The default implementation of this function does nothing.

Reimplemented in aspect::GravityModel::Function< dim >.

declare_parameters()

template<int dim>

static void aspect::GravityModel::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::GravityModel::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::GravityModel::RadialLinear< dim >, aspect::GravityModel::AsciiData< dim >, aspect::GravityModel::Function< dim >, aspect::GravityModel::RadialConstant< dim >, and aspect::GravityModel::Vertical< dim >.

---

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

• /home/bob/source/include/aspect/simulator_access.h
• /home/bob/source/include/aspect/gravity_model/interface.h