ABLATE Source Documentation  0.12.33
ablate::monitors::TurbFlowStats Class Reference
+ Inheritance diagram for ablate::monitors::TurbFlowStats:

Public Member Functions

 TurbFlowStats (const std::vector< std::string > nameIn, const std::shared_ptr< ablate::eos::EOS > eosIn, std::shared_ptr< io::interval::Interval > intervalIn={})
 
PetscMonitorFunction GetPetscFunction () override
 
void Register (std::shared_ptr< ablate::solver::Solver > solverIn) override
 
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::FieldMonitor
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)
 
- Public Member Functions inherited from ablate::monitors::Monitor
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
 

Member Function Documentation

◆ GetPetscFunction()

PetscMonitorFunction ablate::monitors::TurbFlowStats::GetPetscFunction ( )
inlineoverridevirtual

Return a function to be called after every time step. By default null is returned so this is never called

Returns

Reimplemented from ablate::monitors::Monitor.

◆ Restore()

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

Restore the state from the PetscViewer

Parameters
viewer
sequenceNumber
time

Reimplemented from ablate::monitors::FieldMonitor.

◆ Save()

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

Save the state to the PetscViewer

Parameters
viewer
sequenceNumber
time

Reimplemented from ablate::monitors::FieldMonitor.


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