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

#include <tracer_reaction_model.h>

Inheritance diagram for NoneTracerReactionPrefactor:
[legend]

Public Member Functions

 NoneTracerReactionPrefactor ()=default
double value (const std::map< field, double > &) override
void vector_value (const std::map< field, std::vector< double > > &, std::vector< double > &) 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 > &) 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)

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

Dummy tracer reaction prefactor model.

This class is a dummy implementation and always returns zero.

Definition at line 75 of file tracer_reaction_model.h.

Constructor & Destructor Documentation

◆ NoneTracerReactionPrefactor()

NoneTracerReactionPrefactor::NoneTracerReactionPrefactor ( )
default

Default constructor.

Member Function Documentation

◆ jacobian()

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

Returns a dummy jacobian value.

Implements PhysicalPropertyModel.

Definition at line 104 of file tracer_reaction_model.h.

◆ value()

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

Returns a dummy value.

Implements PhysicalPropertyModel.

Definition at line 87 of file tracer_reaction_model.h.

◆ vector_jacobian()

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

Dummy vector jacobian computation.

Implements PhysicalPropertyModel.

Definition at line 114 of file tracer_reaction_model.h.

◆ vector_value()

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

Dummy vector value computation.

Implements PhysicalPropertyModel.

Definition at line 96 of file tracer_reaction_model.h.


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