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

#include <electric_permittivity_model.h>

Inheritance diagram for PolynomialElectricPermittivity:
[legend]

Public Member Functions

 PolynomialElectricPermittivity (const std::vector< double > &p_electric_permittivity_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_permittivity_polynomial_coefficients

Additional Inherited Members

Public Types inherited from PhysicalPropertyModel
enum class  ComplexComponent : std::int8_t { real , imag }
Static Public Member Functions inherited from ElectricPermittivityModel
static std::shared_ptr< ElectricPermittivityModel > model_cast_real (const Parameters::Material &material_properties)
static std::shared_ptr< ElectricPermittivityModel > model_cast_imag (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 permittivity.

Definition at line 120 of file electric_permittivity_model.h.

Constructor & Destructor Documentation

◆ PolynomialElectricPermittivity()

PolynomialElectricPermittivity::PolynomialElectricPermittivity ( const std::vector< double > & p_electric_permittivity_polynomial_coefficients)
inline

Member Function Documentation

◆ jacobian()

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

Calculates the jacobian (the partial derivative) of the electric permittivity 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 permittivity with respect to the specified field.
Remarks
The jacobian is only implemented with respect to the temperature field.

Implements PhysicalPropertyModel.

Definition at line 205 of file electric_permittivity_model.h.

References electric_permittivity_polynomial_coefficients, and temperature.

◆ value()

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

Calculates the value of the electric permittivity.

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

Implements PhysicalPropertyModel.

Definition at line 141 of file electric_permittivity_model.h.

References electric_permittivity, electric_permittivity_polynomial_coefficients, and temperature.

◆ vector_jacobian()

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

Calculates, in a vector, the derivatives of the electric permittivity 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 values of the derivatives of the electric permittivity with respect to the specified field
Remarks
The vector_jacobian is only implemented for the temperature field.

Implements PhysicalPropertyModel.

Definition at line 249 of file electric_permittivity_model.h.

References electric_permittivity_polynomial_coefficients, and temperature.

◆ vector_value()

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

Calculates, in a vector, values of electric permittivities.

Parameters
[in]field_vectorsVector of properties on which the electric permittivities depend
[in,out]property_vectorValues of the electric permittivities

Implements PhysicalPropertyModel.

Definition at line 168 of file electric_permittivity_model.h.

References electric_permittivity, electric_permittivity_polynomial_coefficients, and temperature.

Member Data Documentation

◆ electric_permittivity_polynomial_coefficients

const std::vector<double> PolynomialElectricPermittivity::electric_permittivity_polynomial_coefficients
private

Definition at line 288 of file electric_permittivity_model.h.


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