ABLATE Source Documentation  0.12.34
Public Member Functions | List of all members
ablate::monitors::PhysicsTimeStep Class Reference

#include <physicsTimeStep.hpp>

+ Inheritance diagram for ablate::monitors::PhysicsTimeStep:

Public Member Functions

 PhysicsTimeStep (std::shared_ptr< logs::Log > log={}, std::shared_ptr< io::interval::Interval > interval={})
 
void Register (std::shared_ptr< solver::Solver >) override
 
PetscMonitorFunction GetPetscFunction () override
 
- Public Member Functions inherited from ablate::monitors::Monitor
virtual void * GetContext ()
 

Additional Inherited Members

- Protected Member Functions inherited from ablate::monitors::Monitor
std::shared_ptr< solver::Solver > GetSolver ()
 

Detailed Description

Reports the physics based time stepping from the FVM without enforcing it

Member Function Documentation

◆ GetPetscFunction()

PetscMonitorFunction ablate::monitors::PhysicsTimeStep::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.

◆ Register()

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

Override this function to setup the monitor

Parameters
solverIn

Reimplemented from ablate::monitors::Monitor.

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