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

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

Public Member Functions
virtual	~Interface ()=default
virtual void	initialize ()
virtual double	value (const Point< dim-1 > &surface_point) const =0
virtual double	max_topography () 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::InitialTopographyModel::Interface< dim >

Base class for classes that describe particular initial topographies for the domain.

Definition at line 111 of file simulator_access.h.

Constructor & Destructor Documentation

~Interface()

template<int dim>

virtual aspect::InitialTopographyModel::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::InitialTopographyModel::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::InitialTopographyModel::AsciiData< dim >.

value()

template<int dim>

virtual double aspect::InitialTopographyModel::Interface< dim >::value ( const Point< dim-1 > &  surface_point ) const

pure virtual

Return the value of the elevation at the given surface point.

Note that different geometry models use different conventions for how they describe surface points. In general, the models use their own "natural" coordinate system. For example, box-type geometry models will generally provide points as x-y coordinates on the surface, whereas spherical-type geometry models will generally provide surface points in spherical coordinates.

Implemented in aspect::InitialTopographyModel::AsciiData< dim >, aspect::InitialTopographyModel::Function< dim >, aspect::InitialTopographyModel::ZeroTopography< dim >, and aspect::InitialTopographyModel::PrmPolygon< dim >.

max_topography()

template<int dim>

virtual double aspect::InitialTopographyModel::Interface< dim >::max_topography ( ) const

pure virtual

Return the maximum value of the elevation.

Implemented in aspect::InitialTopographyModel::AsciiData< dim >, aspect::InitialTopographyModel::Function< dim >, aspect::InitialTopographyModel::ZeroTopography< dim >, and aspect::InitialTopographyModel::PrmPolygon< dim >.

declare_parameters()

template<int dim>

static void aspect::InitialTopographyModel::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::InitialTopographyModel::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::InitialTopographyModel::AsciiData< dim >, aspect::InitialTopographyModel::Function< dim >, and aspect::InitialTopographyModel::PrmPolygon< 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/geometry_model/initial_topography_model/interface.h