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

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

Public Member Functions
virtual double	value (const Point< dim-1 > &surface_point) const =0
virtual double	max_topography () const =0
Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual	~InterfaceBase ()=default
virtual void	initialize ()
virtual void	update ()
virtual void	parse_parameters (ParameterHandler &prm)

Additional Inherited Members
Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
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 109 of file simulator_access.h.

Member Function Documentation

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 >.

---

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