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

#include <tracer_diffusivity_model.h>

Inheritance diagram for ConstantTracerDiffusivity:
[legend]

Public Member Functions

 ConstantTracerDiffusivity (const double p_tracer_diffusivity)
double value (const std::map< field, double > &) override
void vector_value (const std::map< field, std::vector< double > > &, 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, 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 tracer_diffusivity

Additional Inherited Members

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

Definition at line 32 of file tracer_diffusivity_model.h.

Constructor & Destructor Documentation

◆ ConstantTracerDiffusivity()

ConstantTracerDiffusivity::ConstantTracerDiffusivity ( const double p_tracer_diffusivity)
inline

Default constructor.

Definition at line 38 of file tracer_diffusivity_model.h.

References tracer_diffusivity.

Member Function Documentation

◆ jacobian()

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

jacobian Calculates the jacobian (the partial derivative) of the diffusivity with respect to a field

Parameters
field_valuesValue of the various fields on which the property may depend.
idIndicator of the field with respect to which the jacobian should be calculated.
Returns
value of the partial derivative of the diffusivity with respect to the field.

Implements PhysicalPropertyModel.

Definition at line 74 of file tracer_diffusivity_model.h.

◆ value()

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

value Calculates the tracer diffusivity

Parameters
fields_valueValue of the various fields on which the property may depend.
Returns
value of the physical property calculated with the fields_value

Implements PhysicalPropertyModel.

Definition at line 48 of file tracer_diffusivity_model.h.

References tracer_diffusivity.

◆ vector_jacobian()

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

vector_jacobian Calculates the derivative of the tracer diffusivity with respect to a field.

Parameters
field_vectorsVector for the values of the fields used to evaluate the property.
idIdentifier of the field with respect to which a derivative should be calculated.
jacobianvector of the value of the derivative of the tracer diffusivity with respect to the field id.

Implements PhysicalPropertyModel.

Definition at line 88 of file tracer_diffusivity_model.h.

◆ vector_value()

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

vector_value Calculates the vector of tracer diffusivity.

Parameters
field_vectorsVectors of the fields on which the diffusivity may depend.
property_vectorVectors of the tracer diffusivity values

Implements PhysicalPropertyModel.

Definition at line 59 of file tracer_diffusivity_model.h.

References tracer_diffusivity.

Member Data Documentation

◆ tracer_diffusivity

const double ConstantTracerDiffusivity::tracer_diffusivity
private

Definition at line 97 of file tracer_diffusivity_model.h.


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