Tempus  Version of the Day
Time Integration
Public Member Functions | List of all members
Tempus::StepperLeapfrogObserver< Scalar > Class Template Reference

StepperLeapfrogObserver class for StepperLeapfrog. More...

#include <Tempus_StepperLeapfrogObserver.hpp>

Inheritance diagram for Tempus::StepperLeapfrogObserver< Scalar >:
Tempus::StepperObserver< Scalar >

Public Member Functions

 StepperLeapfrogObserver ()
 Constructor. More...
 
virtual ~StepperLeapfrogObserver ()
 Destructor. More...
 
virtual void observeBeginTakeStep (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper)
 Observe Stepper at beginning of takeStep. More...
 
virtual void observeBeforeExplicitInitialize (Teuchos::RCP< SolutionHistory< Scalar > > sh, StepperLeapfrog< Scalar > &stepperLF)
 Observe Stepper before Explicit ME evaluation while initializing xDotDot. More...
 
virtual void observeBeforeXDotUpdateInitialize (Teuchos::RCP< SolutionHistory< Scalar > > sh, StepperLeapfrog< Scalar > &stepperLF)
 Observe Stepper before updating xDot while initializing xDotDot. More...
 
virtual void observeBeforeXUpdate (Teuchos::RCP< SolutionHistory< Scalar > > sh, StepperLeapfrog< Scalar > &stepperLF)
 Observe Stepper before updating x. More...
 
virtual void observeBeforeExplicit (Teuchos::RCP< SolutionHistory< Scalar > > sh, StepperLeapfrog< Scalar > &stepperLF)
 Observe Stepper before Explicit ME evaluation. More...
 
virtual void observeBeforeXDotUpdate (Teuchos::RCP< SolutionHistory< Scalar > > sh, StepperLeapfrog< Scalar > &stepperLF)
 Observe Stepper before updating xDot. More...
 
virtual void observeEndTakeStep (Teuchos::RCP< SolutionHistory< Scalar > > sh, Stepper< Scalar > &stepper)
 Observe Stepper at end of takeStep. More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperLeapfrogObserver< Scalar >

StepperLeapfrogObserver class for StepperLeapfrog.

This is a means for application developers to perform tasks during the time steps, e.g.,

  • Compute specific quantities
  • Output information
  • "Massage" the working solution state
  • ...

Design Considerations

  • StepperLeapfrogObserver is not stateless! Developers may touch the solution state! Developers need to be careful not to break the restart (checkpoint) capability.

Definition at line 35 of file Tempus_StepperLeapfrogObserver.hpp.

Constructor & Destructor Documentation

◆ StepperLeapfrogObserver()

template<class Scalar >
Tempus::StepperLeapfrogObserver< Scalar >::StepperLeapfrogObserver ( )
inline

Constructor.

Definition at line 41 of file Tempus_StepperLeapfrogObserver.hpp.

◆ ~StepperLeapfrogObserver()

template<class Scalar >
virtual Tempus::StepperLeapfrogObserver< Scalar >::~StepperLeapfrogObserver ( )
inlinevirtual

Destructor.

Definition at line 44 of file Tempus_StepperLeapfrogObserver.hpp.

Member Function Documentation

◆ observeBeforeExplicit()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeBeforeExplicit ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
StepperLeapfrog< Scalar > &  stepperLF 
)
inlinevirtual

Observe Stepper before Explicit ME evaluation.

Definition at line 67 of file Tempus_StepperLeapfrogObserver.hpp.

◆ observeBeforeExplicitInitialize()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeBeforeExplicitInitialize ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
StepperLeapfrog< Scalar > &  stepperLF 
)
inlinevirtual

Observe Stepper before Explicit ME evaluation while initializing xDotDot.

Definition at line 52 of file Tempus_StepperLeapfrogObserver.hpp.

◆ observeBeforeXDotUpdate()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeBeforeXDotUpdate ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
StepperLeapfrog< Scalar > &  stepperLF 
)
inlinevirtual

Observe Stepper before updating xDot.

Definition at line 72 of file Tempus_StepperLeapfrogObserver.hpp.

◆ observeBeforeXDotUpdateInitialize()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeBeforeXDotUpdateInitialize ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
StepperLeapfrog< Scalar > &  stepperLF 
)
inlinevirtual

Observe Stepper before updating xDot while initializing xDotDot.

Definition at line 57 of file Tempus_StepperLeapfrogObserver.hpp.

◆ observeBeforeXUpdate()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeBeforeXUpdate ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
StepperLeapfrog< Scalar > &  stepperLF 
)
inlinevirtual

Observe Stepper before updating x.

Definition at line 62 of file Tempus_StepperLeapfrogObserver.hpp.

◆ observeBeginTakeStep()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeBeginTakeStep ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepper 
)
inlinevirtual

Observe Stepper at beginning of takeStep.

Implements Tempus::StepperObserver< Scalar >.

Definition at line 47 of file Tempus_StepperLeapfrogObserver.hpp.

◆ observeEndTakeStep()

template<class Scalar >
virtual void Tempus::StepperLeapfrogObserver< Scalar >::observeEndTakeStep ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Stepper< Scalar > &  stepper 
)
inlinevirtual

Observe Stepper at end of takeStep.

Implements Tempus::StepperObserver< Scalar >.

Definition at line 77 of file Tempus_StepperLeapfrogObserver.hpp.

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