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

#include <electric_conductivity_model.h>

Inheritance diagram for PolynomialElectricConductivity:
[legend]

Public Member Functions

 PolynomialElectricConductivity (const std::vector< double > &p_electric_conductivity_polynomial_coefficients)
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, const 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 std::vector< double > electric_conductivity_polynomial_coefficients

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

Polynomial electric conductivity.

Definition at line 111 of file electric_conductivity_model.h.

Constructor & Destructor Documentation

◆ PolynomialElectricConductivity()

PolynomialElectricConductivity::PolynomialElectricConductivity ( const std::vector< double > & p_electric_conductivity_polynomial_coefficients)
inline

Member Function Documentation

◆ jacobian()

double PolynomialElectricConductivity::jacobian ( const std::map< field, double > & field_values,
const field id )
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.
Remarks
The jacobian is only implemented with respect to the temperature field.

Implements PhysicalPropertyModel.

Definition at line 196 of file electric_conductivity_model.h.

References electric_conductivity_polynomial_coefficients, and temperature.

◆ value()

double PolynomialElectricConductivity::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 132 of file electric_conductivity_model.h.

References electric_conductivity_polynomial_coefficients, and temperature.

◆ vector_jacobian()

void PolynomialElectricConductivity::vector_jacobian ( const std::map< field, std::vector< double > > & field_vectors,
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
Remarks
The vector_jacobian is only implemented with respect to the temperature field.

Implements PhysicalPropertyModel.

Definition at line 241 of file electric_conductivity_model.h.

References electric_conductivity_polynomial_coefficients, and temperature.

◆ vector_value()

void PolynomialElectricConductivity::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 159 of file electric_conductivity_model.h.

References electric_conductivity_polynomial_coefficients, and temperature.

Member Data Documentation

◆ electric_conductivity_polynomial_coefficients

const std::vector<double> PolynomialElectricConductivity::electric_conductivity_polynomial_coefficients
private

Definition at line 280 of file electric_conductivity_model.h.


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