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

#include <electric_conductivity_model.h>

Inheritance diagram for ConstantElectricConductivity:
[legend]

Public Member Functions

 ConstantElectricConductivity (const double p_electric_conductivity)
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) override
void vector_jacobian (const std::map< field, std::vector< double > > &, 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 electric_conductivity

Additional Inherited Members

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

Definition at line 33 of file electric_conductivity_model.h.

Constructor & Destructor Documentation

◆ ConstantElectricConductivity()

ConstantElectricConductivity::ConstantElectricConductivity ( const double p_electric_conductivity)
inline

Default constructor.

Definition at line 39 of file electric_conductivity_model.h.

References electric_conductivity.

Member Function Documentation

◆ jacobian()

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

Calculates the jacobian (the partial derivative) of the electric conductivity with respect to a field.

Parameters
[in]field_valuesValue of the various fields on which the property may depend.
[in]idIdentifier of the field with respect to which the jacobian should be calculated
Returns
Value of the partial derivative of the electric conductivity with respect to the field.

Implements PhysicalPropertyModel.

Definition at line 79 of file electric_conductivity_model.h.

◆ value()

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

Calculates the value of the electric conductivity.

Parameters
[in]field_valuesValues of the various fields on which the electric conductivity depends.
Returns
Value of the electric conductivity calculated with the field_values.

Implements PhysicalPropertyModel.

Definition at line 50 of file electric_conductivity_model.h.

References electric_conductivity.

◆ vector_jacobian()

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

Calculates the derivatives of the electric conductivity with respect to a field.

Parameters
[in]field_vectorsVector for the values of the fields used to evaluate the property
[in]idIdentifier of the field with respect to which a derivative should be calculated
[in,out]jacobian_vectorVector of the values of the derivatives of the electric conductivity with respect to the specified field

Implements PhysicalPropertyModel.

Definition at line 96 of file electric_conductivity_model.h.

◆ vector_value()

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

Calculates, in a vector, values of of electric conductivities.

Parameters
[in]field_vectorsVector of fields on which the electric conductivities depend
[in,out]property_vectorValues of the electric conductivities

Implements PhysicalPropertyModel.

Definition at line 62 of file electric_conductivity_model.h.

References electric_conductivity.

Member Data Documentation

◆ electric_conductivity

const double ConstantElectricConductivity::electric_conductivity
private

Definition at line 105 of file electric_conductivity_model.h.


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