ASPECT
aspect::BoundaryTemperature::Interface< dim > Class Template Referenceabstract
Inheritance diagram for aspect::BoundaryTemperature::Interface< dim >:
[legend]

## Public Member Functions

virtual ~Interface ()=default

virtual void initialize ()

virtual double boundary_temperature (const types::boundary_id boundary_indicator, const Point< dim > &position) const

virtual double minimal_temperature (const std::set< types::boundary_id > &fixed_boundary_ids=std::set< types::boundary_id >()) const =0

virtual double maximal_temperature (const std::set< types::boundary_id > &fixed_boundary_ids=std::set< types::boundary_id >()) const =0

virtual void update ()

virtual void parse_parameters (ParameterHandler &prm)

## Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

## Detailed Description

### template<int dim> class aspect::BoundaryTemperature::Interface< dim >

Base class for classes that describe temperature boundary values.

Definition at line 77 of file simulator_access.h.

## § ~Interface()

template<int dim>
 virtual aspect::BoundaryTemperature::Interface< dim >::~Interface ( )
virtualdefault

Destructor. Made virtual to enforce that derived classes also have virtual destructors.

## § initialize()

template<int dim>
 virtual void aspect::BoundaryTemperature::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::BoundaryTemperature::AsciiData< dim >.

## § boundary_temperature()

template<int dim>
 virtual double aspect::BoundaryTemperature::Interface< dim >::boundary_temperature ( const types::boundary_id boundary_indicator, const Point< dim > & position ) const
virtual

Return the temperature that is to hold at a particular position on the boundary of the domain.

Parameters
 boundary_indicator The boundary indicator of the part of the boundary of the domain on which the point is located at which we are requesting the temperature. position The position of the point at which we ask for the temperature.
Returns
Boundary temperature at position position.

## § minimal_temperature()

template<int dim>
 virtual double aspect::BoundaryTemperature::Interface< dim >::minimal_temperature ( const std::set< types::boundary_id > & fixed_boundary_ids = std::set< types::boundary_id >() ) const
pure virtual

Return the minimal temperature on that part of the boundary on which Dirichlet conditions are posed.

This value is used in computing dimensionless numbers such as the Nusselt number indicating heat flux.

## § maximal_temperature()

template<int dim>
 virtual double aspect::BoundaryTemperature::Interface< dim >::maximal_temperature ( const std::set< types::boundary_id > & fixed_boundary_ids = std::set< types::boundary_id >() ) const
pure virtual

Return the maximal temperature on that part of the boundary on which Dirichlet conditions are posed.

This value is used in computing dimensionless numbers such as the Nusselt number indicating heat flux.

## § update()

template<int dim>
 virtual void aspect::BoundaryTemperature::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 temperature 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 temperature change at bottom.

## § declare_parameters()

template<int dim>
 static void aspect::BoundaryTemperature::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::BoundaryTemperature::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.

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