ASPECT
Public Member Functions | Static Public Member Functions | List of all members
aspect::BoundaryHeatFlux::Interface< dim > Class Template Referenceabstract
Inheritance diagram for aspect::BoundaryHeatFlux::Interface< dim >:
Inheritance graph
[legend]

Public Member Functions

virtual ~Interface ()
 
virtual void initialize ()
 
virtual void update ()
 
virtual std::vector< Tensor< 1, dim > > heat_flux (const types::boundary_id boundary_indicator, const MaterialModel::MaterialModelInputs< dim > &material_model_inputs, const MaterialModel::MaterialModelOutputs< dim > &material_model_outputs, const std::vector< Tensor< 1, dim > > &normal_vectors) const =0
 
virtual void parse_parameters (ParameterHandler &prm)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 

Detailed Description

template<int dim>
class aspect::BoundaryHeatFlux::Interface< dim >

Base class

Definition at line 93 of file simulator_access.h.

Constructor & Destructor Documentation

§ ~Interface()

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

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

Member Function Documentation

§ initialize()

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

§ update()

template<int dim>
virtual void aspect::BoundaryHeatFlux::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 heat flux 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 a heat flux change at bottom.

Reimplemented in aspect::BoundaryHeatFlux::Function< dim >.

§ heat_flux()

template<int dim>
virtual std::vector<Tensor<1,dim> > aspect::BoundaryHeatFlux::Interface< dim >::heat_flux ( const types::boundary_id  boundary_indicator,
const MaterialModel::MaterialModelInputs< dim > &  material_model_inputs,
const MaterialModel::MaterialModelOutputs< dim > &  material_model_outputs,
const std::vector< Tensor< 1, dim > > &  normal_vectors 
) const
pure virtual

Compute the heat flux for a list of quadrature points.

The return value would typically be computed as the product of the thermal conductivity material_model_outputs.thermal_conductivities[q] and the temperature gradient at the boundary.

Parameters
boundary_indicatorThe boundary indicator of the part of the boundary of the domain on which the point is located at which we are requesting the fluid pressure gradients.
material_model_inputsThe material property inputs.
material_model_outputsThe material property outputs.
normal_vectorsThe normal vector at each quadrature point.
Returns
A vector of heat flux vectors at the evaluation points.

Implemented in aspect::BoundaryHeatFlux::Function< dim >.

§ declare_parameters()

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

Reimplemented in aspect::BoundaryHeatFlux::Function< dim >.


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