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

#include <tracer_reaction_model.h>

Inheritance diagram for GaussianLevelsetTracerReactionPrefactor:
[legend]

Public Member Functions

 GaussianLevelsetTracerReactionPrefactor (const double p_tracer_reaction_constant_interface, const double p_tracer_reaction_constant_bulk, const double p_thickness, const double p_tracer_reaction_order, const double p_tracer_reaction_threshold)
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, 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 double tracer_reaction_constant_interface
const double tracer_reaction_constant_bulk
const double delta_reaction_constant
const double squared_thickness
const double tracer_reaction_order
const double tracer_reaction_threshold

Additional Inherited Members

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

Reaction prefactor that depends on the Gaussian of the level set.

Definition at line 495 of file tracer_reaction_model.h.

Constructor & Destructor Documentation

◆ GaussianLevelsetTracerReactionPrefactor()

GaussianLevelsetTracerReactionPrefactor::GaussianLevelsetTracerReactionPrefactor ( const double p_tracer_reaction_constant_interface,
const double p_tracer_reaction_constant_bulk,
const double p_thickness,
const double p_tracer_reaction_order,
const double p_tracer_reaction_threshold )
inline

Constructor of the Gaussian level set-dependent reaction prefactor model.

Parameters
[in]p_tracer_reaction_constant_interfaceReaction constant at the fluid-solid interface the solid
[in]p_tracer_reaction_constant_bulkReaction constant in the bulk of the phases
[in]p_thicknessThickness of the Gaussian function used to smooth the property jump
[in]p_tracer_reaction_orderThe reaction order.
[in]p_tracer_reaction_thresholdThe threshold value used to smoothly floor the concentration.

Definition at line 512 of file tracer_reaction_model.h.

References delta_reaction_constant, levelset, PhysicalPropertyModel::model_depends_on, squared_thickness, tracer_concentration, tracer_reaction_constant_bulk, tracer_reaction_constant_interface, tracer_reaction_order, and tracer_reaction_threshold.

Member Function Documentation

◆ jacobian()

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

Compute the jacobian (the partial derivative) of the reaction constant with respect to a specified field.

Parameters
[in]field_valuesValues of the various fields on which the specific heat may depend. The map stores a single value per field.
[in]idIndicator of the field with respect to which the jacobian should be computed.
Returns
Value of the derivative of the reaction constant with respect to the specified field.

Implements PhysicalPropertyModel.

Definition at line 615 of file tracer_reaction_model.h.

References calculate_d_effective_concentration_dC(), calculate_effective_concentration(), delta_reaction_constant, levelset, squared_thickness, tracer_concentration, tracer_reaction_constant_bulk, tracer_reaction_order, and tracer_reaction_threshold.

◆ value()

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

Compute the reaction constant.

Parameters
[in]field_valuesValues of the various fields on which the property may depend. In this case, the reaction constant depends on the level set. The map stores a single value per field.
Returns
Value of the reaction constant computed with the field_values.

Implements PhysicalPropertyModel.

Definition at line 540 of file tracer_reaction_model.h.

References calculate_effective_concentration(), delta_reaction_constant, levelset, squared_thickness, tracer_concentration, tracer_reaction_constant_bulk, tracer_reaction_order, and tracer_reaction_threshold.

◆ vector_jacobian()

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

Compute the derivative of the reaction constant with respect to a field.

Parameters
[in]field_vectorsVector of values of the fields used to evaluate the reaction constant. The map stores a vector of values per field.
[in]idIdentifier of the field with respect to which a derivative should be computed.
[out]jacobianVector of computed derivative values of the reaction constant with respect to the field of the specified id.

Implements PhysicalPropertyModel.

Definition at line 669 of file tracer_reaction_model.h.

References calculate_d_effective_concentration_dC(), calculate_effective_concentration(), delta_reaction_constant, levelset, squared_thickness, tracer_concentration, tracer_reaction_constant_bulk, tracer_reaction_order, and tracer_reaction_threshold.

◆ vector_value()

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

Compute a vector of reaction constant.

Parameters
[in]field_vectorsVectors of the fields on which the reaction constant may depend. In this case, the reaction constant depends on the level set. The map stores a vector of values per field.
[out]property_vectorVectors of computed reaction constants.

Implements PhysicalPropertyModel.

Definition at line 570 of file tracer_reaction_model.h.

References calculate_effective_concentration(), delta_reaction_constant, levelset, squared_thickness, tracer_concentration, tracer_reaction_constant_bulk, tracer_reaction_order, and tracer_reaction_threshold.

Member Data Documentation

◆ delta_reaction_constant

const double GaussianLevelsetTracerReactionPrefactor::delta_reaction_constant
private

Definition at line 727 of file tracer_reaction_model.h.

◆ squared_thickness

const double GaussianLevelsetTracerReactionPrefactor::squared_thickness
private

Definition at line 728 of file tracer_reaction_model.h.

◆ tracer_reaction_constant_bulk

const double GaussianLevelsetTracerReactionPrefactor::tracer_reaction_constant_bulk
private

Definition at line 726 of file tracer_reaction_model.h.

◆ tracer_reaction_constant_interface

const double GaussianLevelsetTracerReactionPrefactor::tracer_reaction_constant_interface
private

Definition at line 725 of file tracer_reaction_model.h.

◆ tracer_reaction_order

const double GaussianLevelsetTracerReactionPrefactor::tracer_reaction_order
private

Definition at line 729 of file tracer_reaction_model.h.

◆ tracer_reaction_threshold

const double GaussianLevelsetTracerReactionPrefactor::tracer_reaction_threshold
private

Definition at line 730 of file tracer_reaction_model.h.


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