ABLATE Source Documentation  0.12.34
ablate::monitors::MixtureFractionMonitor Class Reference
+ Inheritance diagram for ablate::monitors::MixtureFractionMonitor:

Public Member Functions

 MixtureFractionMonitor (std::shared_ptr< MixtureFractionCalculator >)
 
PetscErrorCode Save (PetscViewer viewer, PetscInt sequenceNumber, PetscReal time) override
 
void Register (std::shared_ptr< solver::Solver > solverIn) override
 
- Public Member Functions inherited from ablate::monitors::FieldMonitor
const std::string & GetId () const override
 
void Register (std::string id, std::shared_ptr< solver::Solver > solverIn, std::vector< std::shared_ptr< domain::FieldDescriptor >> fields)
 
PetscErrorCode Restore (PetscViewer viewer, PetscInt sequenceNumber, PetscReal time) override
 
- Public Member Functions inherited from ablate::monitors::Monitor
virtual PetscMonitorFunction GetPetscFunction ()
 
virtual void * GetContext ()
 
- Public Member Functions inherited from ablate::io::Serializable
virtual SerializerType Serialize () const
 

Additional Inherited Members

- Public Types inherited from ablate::io::Serializable
enum class  SerializerType { none , collective , serial }
 
- Protected Member Functions inherited from ablate::monitors::Monitor
std::shared_ptr< solver::SolverGetSolver ()
 
- Static Protected Member Functions inherited from ablate::io::Serializable
static PetscErrorCode SaveKeyValue (PetscViewer viewer, const char *name, PetscScalar value)
 
static PetscErrorCode RestoreKeyValue (PetscViewer viewer, const char *name, PetscScalar &value)
 
template<class T >
static PetscErrorCode SaveKeyValue (PetscViewer viewer, const char *name, T value)
 
template<class T >
static PetscErrorCode RestoreKeyValue (PetscViewer viewer, const char *name, T &value)
 
template<class T >
static SerializerType DetermineSerializerType (const T &types)
 
- Protected Attributes inherited from ablate::monitors::FieldMonitor
std::shared_ptr< ablate::domain::SubDomainmonitorSubDomain = nullptr
 

Constructor & Destructor Documentation

◆ MixtureFractionMonitor()

ablate::monitors::MixtureFractionMonitor::MixtureFractionMonitor ( std::shared_ptr< MixtureFractionCalculator mixtureFractionCalculator)
explicit

Create the mixture fraction monitor using a mixture fraction calculator

Member Function Documentation

◆ Register()

void ablate::monitors::MixtureFractionMonitor::Register ( std::shared_ptr< solver::Solver solverIn)
overridevirtual

this call setups the monitor and defines the mixture fraction fields method

Parameters
solverIn

Reimplemented from ablate::monitors::FieldMonitor.

◆ Save()

PetscErrorCode ablate::monitors::MixtureFractionMonitor::Save ( PetscViewer  viewer,
PetscInt  sequenceNumber,
PetscReal  time 
)
overridevirtual

Update the fields and save the results to an hdf5 file

Parameters
viewer
sequenceNumber
time

Reimplemented from ablate::monitors::FieldMonitor.


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