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

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

Public Member Functions
virtual void	evaluate (const MaterialModel::MaterialModelInputs< dim > &material_model_inputs, const MaterialModel::MaterialModelOutputs< dim > &material_model_outputs, HeatingModel::HeatingModelOutputs &heating_model_outputs) const =0
virtual void	create_additional_material_model_outputs (MaterialModel::MaterialModelOutputs< dim > &outputs) const
virtual void	create_additional_material_model_inputs (MaterialModel::MaterialModelInputs< dim > &inputs) const
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::HeatingModel::Interface< dim >

A base class for parameterizations of heating models.

Definition at line 122 of file interface.h.

Member Function Documentation

evaluate()

template<int dim>

virtual void aspect::HeatingModel::Interface< dim >::evaluate ( const MaterialModel::MaterialModelInputs< dim > &  material_model_inputs, const MaterialModel::MaterialModelOutputs< dim > &  material_model_outputs, HeatingModel::HeatingModelOutputs &  heating_model_outputs  ) const

pure virtual

Function to compute the heating terms in heating_model_outputs given the inputs in material_model_inputs and the outputs of the material model in material_model_outputs. All parts of the heating_model_outputs structure have to be filled, heating_source_terms with the value of the heating rate and lhs_latent_heat_terms with the part of the latent heat that depends on the temperature change (and thus ends up on the left hand side of the temperature equation) at each quadrature point as defined in material_model_inputs, setting them to zero if they are not to be used in the computation.

Implemented in aspect::HeatingModel::AdiabaticHeating< dim >, aspect::HeatingModel::LatentHeat< dim >, aspect::HeatingModel::AdiabaticHeatingMelt< dim >, aspect::HeatingModel::ShearHeatingMelt< dim >, aspect::HeatingModel::Function< dim >, aspect::HeatingModel::RadioactiveDecay< dim >, aspect::HeatingModel::ShearHeating< dim >, aspect::HeatingModel::LatentHeatMelt< dim >, aspect::HeatingModel::CompositionalHeating< dim >, and aspect::HeatingModel::ConstantHeating< dim >.

create_additional_material_model_outputs()

template<int dim>

virtual void aspect::HeatingModel::Interface< dim >::create_additional_material_model_outputs ( MaterialModel::MaterialModelOutputs< dim > &  outputs ) const

virtual

Allow the heating model to attach additional material model outputs. The default implementation of this function does not add any outputs. Consequently, derived classes do not have to overload this function if they do not need any additional outputs.

Reimplemented in aspect::HeatingModel::AdiabaticHeatingMelt< dim >, aspect::HeatingModel::LatentHeatMelt< dim >, aspect::HeatingModel::ShearHeatingMelt< dim >, and aspect::HeatingModel::ShearHeating< dim >.

create_additional_material_model_inputs()

template<int dim>

virtual void aspect::HeatingModel::Interface< dim >::create_additional_material_model_inputs ( MaterialModel::MaterialModelInputs< dim > &  inputs ) const

virtual

Allow the heating model to attach additional material model inputs it needs. The default implementation of this function does not add any inputs. Consequently, derived classes do not have to overload this function if they do not need any additional inputs.

Reimplemented in aspect::HeatingModel::AdiabaticHeatingMelt< dim >, and aspect::HeatingModel::ShearHeatingMelt< dim >.

---

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

• /home/bob/source/include/aspect/heating_model/interface.h