ablate::monitors::FieldMonitor Class Reference

#include <fieldMonitor.hpp>

Inheritance diagram for ablate::monitors::FieldMonitor:

Public Member Functions
const std::string &	GetId () const override
void	Register (std::shared_ptr< solver::Solver > solverIn) override
void	Register (std::string id, std::shared_ptr< solver::Solver > solverIn, std::vector< std::shared_ptr< domain::FieldDescriptor >> fields)
PetscErrorCode	Save (PetscViewer viewer, PetscInt sequenceNumber, PetscReal time) override
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

Protected Attributes
std::shared_ptr< ablate::domain::SubDomain >	monitorSubDomain = nullptr

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::Solver >	GetSolver ()
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)

Detailed Description

An abstract class that provides support for creating, writing, and outputting new fields

Member Function Documentation

GetId()

const std::string& ablate::monitors::FieldMonitor::GetId ( ) const

inlineoverridevirtual

only required function, returns the id of the object. Should be unique for the simulation

Returns

Implements ablate::io::Serializable.

Register() [1/2]

void ablate::monitors::FieldMonitor::Register ( std::shared_ptr< solver::Solver >  solverIn )

inlineoverridevirtual

In order to use the base class, the Register call must be overridden and Register(std::shared_ptr<solver::Solver> solverIn, std::vector<domain::FieldDescription> fields) must be called from the method

Parameters

solverIn

Reimplemented from ablate::monitors::Monitor.

Reimplemented in ablate::monitors::MixtureFractionMonitor.

Register() [2/2]

void ablate::monitors::FieldMonitor::Register	(	std::string	id,
		std::shared_ptr< solver::Solver >	solverIn,
		std::vector< std::shared_ptr< domain::FieldDescriptor >>	fields
	)

In order to use the base class, the Register call must be overridden and

Parameters

solverIn

Restore()

PetscErrorCode ablate::monitors::FieldMonitor::Restore ( PetscViewer  viewer, PetscInt  sequenceNumber, PetscReal  time  )

overridevirtual

Restore the state from the PetscViewer

Parameters

viewer
sequenceNumber
time

Implements ablate::io::Serializable.

Reimplemented in ablate::monitors::TurbFlowStats.

Save()

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

overridevirtual

Save the state to the PetscViewer

Parameters

viewer
sequenceNumber
time

Implements ablate::io::Serializable.

Reimplemented in ablate::monitors::TurbFlowStats, ablate::monitors::RadiationFieldMonitor, and ablate::monitors::MixtureFractionMonitor.

---

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

• src/monitors/fieldMonitor.hpp
• src/monitors/fieldMonitor.cpp