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

#include <magnetic_permeability_model.h>

Inheritance diagram for PolynomialMagneticPermeability:
[legend]

Public Member Functions

 PolynomialMagneticPermeability (const std::vector< double > &p_magnetic_permeability_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 > magnetic_permeability_polynomial_coefficients

Additional Inherited Members

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

Definition at line 120 of file magnetic_permeability_model.h.

Constructor & Destructor Documentation

◆ PolynomialMagneticPermeability()

PolynomialMagneticPermeability::PolynomialMagneticPermeability ( const std::vector< double > & p_magnetic_permeability_polynomial_coefficients)
inline

Member Function Documentation

◆ jacobian()

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

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

Implements PhysicalPropertyModel.

Definition at line 204 of file magnetic_permeability_model.h.

References magnetic_permeability_polynomial_coefficients, and temperature.

◆ value()

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

Calculates the value of the magnetic permeability.

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

Implements PhysicalPropertyModel.

Definition at line 141 of file magnetic_permeability_model.h.

References magnetic_permeability, magnetic_permeability_polynomial_coefficients, and temperature.

◆ vector_jacobian()

void PolynomialMagneticPermeability::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 magnetic permeability 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 magnetic permeability with respect to the specified field
Remarks
The vector_jacobian is only implemented with respect to the temperature.

Implements PhysicalPropertyModel.

Definition at line 249 of file magnetic_permeability_model.h.

References magnetic_permeability_polynomial_coefficients, and temperature.

◆ vector_value()

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

Calculates, in a vector, values of magnetic permeabilities.

Parameters
[in]field_vectorsVector of properties on which the magnetic permeabilities depend
[in,out]property_vectorValues of the magnetic permeabilities

Implements PhysicalPropertyModel.

Definition at line 168 of file magnetic_permeability_model.h.

References magnetic_permeability, magnetic_permeability_polynomial_coefficients, and temperature.

Member Data Documentation

◆ magnetic_permeability_polynomial_coefficients

const std::vector<double> PolynomialMagneticPermeability::magnetic_permeability_polynomial_coefficients
private

Definition at line 288 of file magnetic_permeability_model.h.


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