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

Public Member Functions

virtual double value (const Point< dim-1 > &p) const
 
virtual double max_topography () const
 
virtual void parse_parameters (ParameterHandler &prm)
 
- Public Member Functions inherited from aspect::InitialTopographyModel::Interface< dim >
virtual ~Interface ()
 
virtual void initialize ()
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::InitialTopographyModel::Interface< dim >
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>
virtual double aspect::InitialTopographyModel::PrmPolygon< dim >::value ( const Point< dim-1 > &  p) const
virtual

Return the value of the topography for a point.

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

§ max_topography()

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

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>
virtual void aspect::InitialTopographyModel::PrmPolygon< dim >::parse_parameters ( ParameterHandler prm)
virtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::InitialTopographyModel::Interface< dim >.

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 74 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 79 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 84 of file prm_polygon.h.


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