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

Public Member Functions

 Function ()
 
virtual Tensor< 1, dim > gravity_vector (const Point< dim > &position) const
 
virtual void parse_parameters (ParameterHandler &prm)
 
- Public Member Functions inherited from aspect::GravityModel::Interface< dim >
virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::GravityModel::Interface< dim >
static void declare_parameters (ParameterHandler &prm)
 

Private Attributes

Functions::ParsedFunction< dim > function
 

Detailed Description

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

A class that implements gravity based on a functional description provided in the input file.

Definition at line 42 of file function.h.

Constructor & Destructor Documentation

§ Function()

template<int dim>
aspect::GravityModel::Function< dim >::Function ( )

Constructor.

Member Function Documentation

§ gravity_vector()

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

Return the gravity vector as a function of position.

Implements aspect::GravityModel::Interface< dim >.

§ declare_parameters()

template<int dim>
static void aspect::GravityModel::Function< 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::Function< 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 from aspect::GravityModel::Interface< dim >.

Member Data Documentation

§ function

template<int dim>
Functions::ParsedFunction<dim> aspect::GravityModel::Function< dim >::function
private

A function object representing the gravity.

Definition at line 80 of file function.h.


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