Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
ConstantSpecificHeat Class Reference

#include <specific_heat_model.h>

Inheritance diagram for ConstantSpecificHeat:
[legend]

Public Member Functions

 ConstantSpecificHeat (const double p_specific_heat)
double value (const std::map< field, double > &field_values) override
void vector_value (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &property_vector) override
double jacobian (const std::map< field, double > &field_values, field id) override
void vector_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector) override
Public Member Functions inherited from PhysicalPropertyModel
 PhysicalPropertyModel ()
virtual ~PhysicalPropertyModel ()=default
bool depends_on (const field &id)
void provide_simulation_control (std::shared_ptr< SimulationControl > &p_simulation_control)
double numerical_jacobian (const std::map< field, double > &field_values, const field id)
void vector_numerical_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector)

Private Attributes

const double specific_heat

Additional Inherited Members

Public Types inherited from PhysicalPropertyModel
enum class  ComplexComponent : std::int8_t { real , imag }
Static Public Member Functions inherited from SpecificHeatModel
static std::shared_ptr< SpecificHeatModel > model_cast (const Parameters::Material &material_properties)
Protected Member Functions inherited from PhysicalPropertyModel
std::shared_ptr< SimulationControl > & get_simulation_control ()
Protected Attributes inherited from PhysicalPropertyModel
std::map< field, bool > model_depends_on

Detailed Description

Constant specific heat model.

Definition at line 39 of file specific_heat_model.h.

Constructor & Destructor Documentation

◆ ConstantSpecificHeat()

ConstantSpecificHeat::ConstantSpecificHeat ( const double p_specific_heat)
inline

Constructor of the constant specific heat model.

Parameters
[in]p_specific_heatConstant specific heat value.

Definition at line 47 of file specific_heat_model.h.

References specific_heat.

Member Function Documentation

◆ jacobian()

double ConstantSpecificHeat::jacobian ( const std::map< field, double > & field_values,
field id )
inlineoverridevirtual

Compute the jacobian (the partial derivative) of the specific heat with respect to a specified field.

Parameters
[in]field_valuesValues of the various fields on which the specific heat may depend. The map stores a single value per field.
[in]idIndicator of the field with respect to which the jacobian should be computed.
Note
Here, the field_values and id parameters are ignored since the specific heat remains constant.
Returns
Value of the derivative of the specific heat with respect to the specified field. Since the specific heat remains constant, this function returns zero.

Implements PhysicalPropertyModel.

Definition at line 106 of file specific_heat_model.h.

◆ value()

double ConstantSpecificHeat::value ( const std::map< field, double > & field_values)
inlineoverridevirtual

Compute specific heat value.

Parameters
[in]field_valuesValue of the various field on which the specific heat may depend. The map stores a single value per field.
Note
Here, the field_values parameter is ignored since the specific heat remains constant.
Returns
Specific heat value.

Implements PhysicalPropertyModel.

Definition at line 63 of file specific_heat_model.h.

References specific_heat.

◆ vector_jacobian()

void ConstantSpecificHeat::vector_jacobian ( const std::map< field, std::vector< double > > & field_vectors,
const field id,
std::vector< double > & jacobian_vector )
inlineoverridevirtual

Computes the derivative of the specific heat with respect to specified fields.

Parameters
[in]field_vectorsVector of values of the fields used to evaluate the specific heat. The map stores a vector of values per field.
[in]idIdentifier of the field with respect to which a derivative should be computed.
[out]jacobianVector of computed derivative values of the specific heat with respect to the field of the specified id. In this case, it returns a vector of zeros since the specific heat remains constant.
Note
Here, the field_vectors and id parameters are ignored since the specific heat remains constant.

Implements PhysicalPropertyModel.

Definition at line 133 of file specific_heat_model.h.

◆ vector_value()

void ConstantSpecificHeat::vector_value ( const std::map< field, std::vector< double > > & field_vectors,
std::vector< double > & property_vector )
inlineoverridevirtual

vector_value Compute specific heat values.

Parameters
[in]field_vectorsVectors of the fields on which the specific heat may depend. The map stores a vector of values per field.
[out]property_vectorVector of computed specific heat values.
Note
Here, the field_vectors parameter is ignored since the specific heat remains constant.

Implements PhysicalPropertyModel.

Definition at line 81 of file specific_heat_model.h.

References specific_heat.

Member Data Documentation

◆ specific_heat

const double ConstantSpecificHeat::specific_heat
private

Definition at line 143 of file specific_heat_model.h.


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