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

#include <magnetic_permeability_model.h>

Inheritance diagram for ConstantMagneticPermeability:
[legend]

Public Member Functions

 ConstantMagneticPermeability (const double p_magnetic_permeability)
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 magnetic_permeability

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

Constant magnetic permeability.

Definition at line 42 of file magnetic_permeability_model.h.

Constructor & Destructor Documentation

◆ ConstantMagneticPermeability()

ConstantMagneticPermeability::ConstantMagneticPermeability ( const double p_magnetic_permeability)
inline

Default constructor.

Definition at line 48 of file magnetic_permeability_model.h.

References magnetic_permeability.

Member Function Documentation

◆ jacobian()

double ConstantMagneticPermeability::jacobian ( const std::map< field, double > & ,
field  )
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.

Implements PhysicalPropertyModel.

Definition at line 88 of file magnetic_permeability_model.h.

◆ value()

double ConstantMagneticPermeability::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 59 of file magnetic_permeability_model.h.

References magnetic_permeability.

◆ vector_jacobian()

void ConstantMagneticPermeability::vector_jacobian ( const std::map< field, std::vector< double > > & ,
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

Implements PhysicalPropertyModel.

Definition at line 105 of file magnetic_permeability_model.h.

◆ vector_value()

void ConstantMagneticPermeability::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 71 of file magnetic_permeability_model.h.

References magnetic_permeability.

Member Data Documentation

◆ magnetic_permeability

const double ConstantMagneticPermeability::magnetic_permeability
private

Definition at line 114 of file magnetic_permeability_model.h.


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