ablate::monitors::Monitor Class Reference

Inheritance diagram for ablate::monitors::Monitor:

Public Member Functions
virtual void	Register (std::shared_ptr< solver::Solver > solverIn)
virtual PetscMonitorFunction	GetPetscFunction ()
virtual void *	GetContext ()

Protected Member Functions
std::shared_ptr< solver::Solver >	GetSolver ()

Member Function Documentation

GetContext()

virtual void* ablate::monitors::Monitor::GetContext ( )

inlinevirtual

return context to be returned to the PetscMonitorFunction. By default this is a pointer to this instance

Reimplemented in ablate::monitors::RadiationFlux.

GetPetscFunction()

virtual PetscMonitorFunction ablate::monitors::Monitor::GetPetscFunction ( )

inlinevirtual

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

Returns

Reimplemented in ablate::monitors::TurbFlowStats, ablate::monitors::TimeStepMonitor, ablate::monitors::SolutionErrorMonitor, ablate::monitors::RocketMonitor, ablate::monitors::RadiationFlux, ablate::monitors::RadiationFieldMonitor, ablate::monitors::Probes, ablate::monitors::PhysicsTimeStep, ablate::monitors::ParticleCount, ablate::monitors::ParticleAverage, ablate::monitors::MaxMinAverage, ablate::monitors::IgnitionDelayTemperature, ablate::monitors::IgnitionDelayPeakYi, ablate::monitors::FieldErrorMonitor, ablate::monitors::ExtractLineMonitor, ablate::monitors::DmViewFromOptions, ablate::monitors::CurveMonitor, and ablate::monitors::BoundarySolverMonitor.

Register()

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

inlinevirtual

Override this function to setup the monitor

Parameters

solverIn

Reimplemented in ablate::monitors::RocketMonitor, ablate::monitors::PhysicsTimeStep, ablate::monitors::ParticleCount, ablate::monitors::ParticleAverage, ablate::monitors::IgnitionDelayTemperature, ablate::monitors::IgnitionDelayPeakYi, ablate::monitors::ExtractLineMonitor, ablate::monitors::DmViewFromOptions, ablate::monitors::CurveMonitor, ablate::monitors::RadiationFlux, ablate::monitors::MixtureFractionMonitor, ablate::monitors::FieldMonitor, ablate::monitors::ChemTabMonitor, ablate::monitors::Probes, and ablate::monitors::BoundarySolverMonitor.

---

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

• src/monitors/monitor.hpp