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

Public Member Functions

virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual DEAL_II_DEPRECATED Tensor< 1, dim > traction (const Point< dim > &position, const Tensor< 1, dim > &normal_vector) const
 
virtual Tensor< 1, dim > boundary_traction (const types::boundary_id boundary_indicator, const Point< dim > &position, const Tensor< 1, dim > &normal_vector) const
 
virtual void parse_parameters (ParameterHandler &prm)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Protected Attributes

const GeometryModel::Interface< dim > * geometry_model
 

Detailed Description

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

A base class for parameterizations of traction boundary conditions.

Definition at line 104 of file simulator_access.h.

Constructor & Destructor Documentation

§ ~Interface()

template<int dim>
virtual aspect::BoundaryTraction::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::BoundaryTraction::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::BoundaryTraction::AsciiData< dim >, and aspect::BoundaryTraction::InitialLithostaticPressure< dim >.

§ update()

template<int dim>
virtual void aspect::BoundaryTraction::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 traction 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 stresses for a set of plates.

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

§ traction()

template<int dim>
virtual DEAL_II_DEPRECATED Tensor<1,dim> aspect::BoundaryTraction::Interface< dim >::traction ( const Point< dim > &  position,
const Tensor< 1, dim > &  normal_vector 
) const
virtual

Return the boundary traction as a function of position.

Deprecated:
Use boundary_traction(const types::boundary_id boundary_indicator, const Point<dim> &position, const Tensor<1,dim> &normal_vector) const instead.

Reimplemented in aspect::BoundaryTraction::InitialLithostaticPressure< dim >.

§ boundary_traction()

template<int dim>
virtual Tensor<1,dim> aspect::BoundaryTraction::Interface< dim >::boundary_traction ( const types::boundary_id  boundary_indicator,
const Point< dim > &  position,
const Tensor< 1, dim > &  normal_vector 
) const
virtual

Return the boundary traction as a function of position. The (outward) normal vector to the domain is also provided as a second argument.

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

§ declare_parameters()

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

Member Data Documentation

§ geometry_model

template<int dim>
const GeometryModel::Interface<dim>* aspect::BoundaryTraction::Interface< dim >::geometry_model
protected

Pointer to the geometry object in use.

Definition at line 129 of file interface.h.


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