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

#include <thermal_expansion_model.h>

Inheritance diagram for ConstantThermalExpansion:
[legend]

Public Member Functions

 ConstantThermalExpansion (const double p_thermal_expansion)
double value (const std::map< field, double > &) override
void vector_value (const std::map< field, std::vector< double > > &, std::vector< double > &property_vector) override
double jacobian (const std::map< field, double > &, field) override
void vector_jacobian (const std::map< field, std::vector< double > > &, const field, 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 thermal_expansion

Additional Inherited Members

Public Types inherited from PhysicalPropertyModel
enum class  ComplexComponent : std::int8_t { real , imag }
Static Public Member Functions inherited from ThermalExpansionModel
static std::shared_ptr< ThermalExpansionModel > 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 thermal expansion coefficient.

Definition at line 33 of file thermal_expansion_model.h.

Constructor & Destructor Documentation

◆ ConstantThermalExpansion()

ConstantThermalExpansion::ConstantThermalExpansion ( const double p_thermal_expansion)
inline

Default constructor.

Definition at line 39 of file thermal_expansion_model.h.

References thermal_expansion.

Member Function Documentation

◆ jacobian()

double ConstantThermalExpansion::jacobian ( const std::map< field, double > & ,
field  )
inlineoverridevirtual

jacobian Calculates the jacobian (the partial derivative) of the thermal expansion with respect to a field

Parameters
field_valuesValue of the various fields on which the property may depend.
idIndicator of the field with respect to which the jacobian should be calculated.
Returns
value of the partial derivative of the thermal expansion with respect to the field.

Implements PhysicalPropertyModel.

Definition at line 75 of file thermal_expansion_model.h.

◆ value()

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

value Calculates the thermale expansion

Parameters
fields_valueValue of the various field on which the property may depend.
Returns
value of the physical property calculated with the fields_value

Implements PhysicalPropertyModel.

Definition at line 49 of file thermal_expansion_model.h.

References thermal_expansion.

◆ vector_jacobian()

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

vector_jacobian Calculates the derivative of the thermal expansion with respect to a field.

Parameters
field_vectorsVector for the values of the fields used to evaluate the property.
idIdentifier of the field with respect to which a derivative should be calculated.
jacobianvector of the value of the derivative of the thermal expansion with respect to the field id.

Implements PhysicalPropertyModel.

Definition at line 89 of file thermal_expansion_model.h.

◆ vector_value()

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

vector_value Calculates the vector of thermal expansion.

Parameters
field_vectorsVectors of the fields on which the thermal expansion may depend.
property_vectorVectors of the thermal expansion values

Implements PhysicalPropertyModel.

Definition at line 60 of file thermal_expansion_model.h.

References thermal_expansion.

Member Data Documentation

◆ thermal_expansion

const double ConstantThermalExpansion::thermal_expansion
private

Definition at line 98 of file thermal_expansion_model.h.


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