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

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

Public Member Functions
virtual double	boundary_temperature (const types::boundary_id boundary_indicator, const Point< dim > &position) const =0
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
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::BoundaryTemperature::Interface< dim >

Base class for classes that describe temperature boundary values.

Definition at line 77 of file simulator_access.h.

Member Function Documentation

boundary_temperature()

template<int dim>

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

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

Implemented in aspect::BoundaryTemperature::DynamicCore< dim >, aspect::BoundaryTemperature::AsciiData< dim >, aspect::BoundaryTemperature::InitialTemperature< dim >, aspect::BoundaryTemperature::Function< dim >, aspect::BoundaryTemperature::SphericalConstant< dim >, aspect::BoundaryTemperature::Constant< dim >, aspect::BoundaryTemperature::TwoMergedBoxes< dim >, and aspect::BoundaryTemperature::Box< dim >.

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.

Implemented in aspect::BoundaryTemperature::DynamicCore< dim >, aspect::BoundaryTemperature::AsciiData< dim >, aspect::BoundaryTemperature::Function< dim >, aspect::BoundaryTemperature::InitialTemperature< dim >, aspect::BoundaryTemperature::SphericalConstant< dim >, aspect::BoundaryTemperature::Constant< dim >, aspect::BoundaryTemperature::TwoMergedBoxes< dim >, and aspect::BoundaryTemperature::Box< dim >.

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.

Implemented in aspect::BoundaryTemperature::DynamicCore< dim >, aspect::BoundaryTemperature::AsciiData< dim >, aspect::BoundaryTemperature::Function< dim >, aspect::BoundaryTemperature::InitialTemperature< dim >, aspect::BoundaryTemperature::SphericalConstant< dim >, aspect::BoundaryTemperature::Constant< dim >, aspect::BoundaryTemperature::TwoMergedBoxes< dim >, and aspect::BoundaryTemperature::Box< 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/boundary_temperature/interface.h