ASPECT
Public Member Functions | Private Attributes | List of all members
aspect::HeatingModel::ConstantHeating< dim > Class Template Reference
Describing terms on the right hand side of the temperature equation
Inheritance diagram for aspect::HeatingModel::ConstantHeating< dim >:
Inheritance graph
[legend]

Public Member Functions

void evaluate (const MaterialModel::MaterialModelInputs< dim > &material_model_inputs, const MaterialModel::MaterialModelOutputs< dim > &material_model_outputs, HeatingModel::HeatingModelOutputs &heating_model_outputs) const override
 
- Public Member Functions inherited from aspect::HeatingModel::Interface< dim >
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 ()
 

Private Attributes

double radiogenic_heating_rate
 

Functions used in dealing with run-time parameters

void parse_parameters (ParameterHandler &prm) override
 
static void declare_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::ConstantHeating< dim >

A class that implements a constant radiogenic heating rate.

Definition at line 39 of file constant_heating.h.

Member Function Documentation

§ evaluate()

template<int dim>
void aspect::HeatingModel::ConstantHeating< dim >::evaluate ( const MaterialModel::MaterialModelInputs< dim > &  material_model_inputs,
const MaterialModel::MaterialModelOutputs< dim > &  material_model_outputs,
HeatingModel::HeatingModelOutputs &  heating_model_outputs 
) const
overridevirtual

Return the heating terms. For the current class, this function obviously simply returns a constant value.

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

§ declare_parameters()

template<int dim>
static void aspect::HeatingModel::ConstantHeating< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::HeatingModel::ConstantHeating< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

§ radiogenic_heating_rate

template<int dim>
double aspect::HeatingModel::ConstantHeating< dim >::radiogenic_heating_rate
private

Definition at line 73 of file constant_heating.h.

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