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

#include <thermal_conductivity_model.h>

Inheritance diagram for ThermalConductivityLinear:
[legend]

Public Member Functions

 ThermalConductivityLinear (const double A, const double B)
double value (const std::map< field, double > &fields_value) 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) 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 A
const double B

Additional Inherited Members

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

Implements a linear temperature-dependent thermal conductivity of the form k = A + BT.

Definition at line 107 of file thermal_conductivity_model.h.

Constructor & Destructor Documentation

◆ ThermalConductivityLinear()

ThermalConductivityLinear::ThermalConductivityLinear ( const double A,
const double B )
inline

Default constructor.

Definition at line 113 of file thermal_conductivity_model.h.

References A, B, PhysicalPropertyModel::model_depends_on, and temperature.

Member Function Documentation

◆ jacobian()

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

jacobian Calculates the jacobian (the partial derivative) of the thermal conductivity 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 conductivity with respect to the field.

Implements PhysicalPropertyModel.

Definition at line 160 of file thermal_conductivity_model.h.

References B.

◆ value()

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

value Calculates the value the thermal conductivity

Parameters
fields_valueValue of the various field on which the thermal conductivity depends.
Returns
value of the thermal conductivity calculated with the fields_value.

Implements PhysicalPropertyModel.

Definition at line 126 of file thermal_conductivity_model.h.

References A, B, and temperature.

◆ vector_jacobian()

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

vector_jacobian Calculate the derivative of the thermal conductivity 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 conductivity with respect to the field id

Implements PhysicalPropertyModel.

Definition at line 174 of file thermal_conductivity_model.h.

References B.

◆ vector_value()

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

vector_value Calculates the vector value of thermal conductivities

Parameters
field_vectorsVector of properties on which the thermal conductivities depend
property_vectorValues of the thermal conductivities

Implements PhysicalPropertyModel.

Definition at line 140 of file thermal_conductivity_model.h.

References A, B, and temperature.

Member Data Documentation

◆ A

const double ThermalConductivityLinear::A
private

Definition at line 183 of file thermal_conductivity_model.h.

◆ B

const double ThermalConductivityLinear::B
private

Definition at line 184 of file thermal_conductivity_model.h.


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