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

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

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

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)
Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void	declare_parameters (ParameterHandler &prm)

Private Attributes
std::vector< double >	topography_values
double	maximum_topography
std::vector< std::vector< Point< 2 > > >	point_lists

Detailed Description

template<int dim>
class aspect::InitialTopographyModel::PrmPolygon< dim >

A class that describes an initial topography for the geometry model, by defining a set of polygons on the surface from the prm file. It sets the elevation in each polygon to a constant value.

Definition at line 40 of file prm_polygon.h.

Member Function Documentation

value()

template<int dim>

double aspect::InitialTopographyModel::PrmPolygon< dim >::value ( const Point< dim-1 > &  p ) const

overridevirtual

Return the value of the topography for a point.

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

max_topography()

template<int dim>

double aspect::InitialTopographyModel::PrmPolygon< dim >::max_topography ( ) const

overridevirtual

Return the maximum value of the elevation.

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

declare_parameters()

template<int dim>

static void aspect::InitialTopographyModel::PrmPolygon< dim >::declare_parameters ( ParameterHandler &  prm )

static

Declare the parameters this class takes through input files.

parse_parameters()

template<int dim>

void aspect::InitialTopographyModel::PrmPolygon< dim >::parse_parameters ( ParameterHandler &  prm )

overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

topography_values

template<int dim>

std::vector<double> aspect::InitialTopographyModel::PrmPolygon< dim >::topography_values

private

The values of the topography are stored in a vector.

Definition at line 70 of file prm_polygon.h.

maximum_topography

template<int dim>

double aspect::InitialTopographyModel::PrmPolygon< dim >::maximum_topography

private

The maximum topography in this model

Definition at line 75 of file prm_polygon.h.

point_lists

template<int dim>

std::vector<std::vector<Point<2> > > aspect::InitialTopographyModel::PrmPolygon< dim >::point_lists

private

The polygons and their points are stored in this vector.

Definition at line 80 of file prm_polygon.h.

---

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

• /home/bob/source/include/aspect/geometry_model/initial_topography_model/prm_polygon.h