Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus::StepperSubcyclingModifierDefault< Scalar > Class Template Reference

Default modifier for StepperSubcycling. More...

#include <Tempus_StepperSubcyclingModifierDefault.hpp>

Inheritance diagram for Tempus::StepperSubcyclingModifierDefault< Scalar >:
Tempus::StepperSubcyclingModifierBase< Scalar > Tempus::StepperSubcyclingAppAction< Scalar >

Public Member Functions

 StepperSubcyclingModifierDefault ()
 Constructor.
 
virtual ~StepperSubcyclingModifierDefault ()
 Destructor.
 
virtual void modify (Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperSubcycling< Scalar > >, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)
 Modify Subcycling Stepper.
 
virtual void modify (Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperSubcycling< Scalar > >, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Modify Subcycling Stepper.
 
- Public Member Functions inherited from Tempus::StepperSubcyclingAppAction< Scalar >
 StepperSubcyclingAppAction ()
 Constructor.
 
virtual ~StepperSubcyclingAppAction ()
 Destructor.
 
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperSubcycling< Scalar > > stepper, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Execute application action for Subcycling Stepper.
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperSubcyclingAppAction< Scalar >
enum  ACTION_LOCATION { BEGIN_STEP , END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperSubcyclingModifierDefault< Scalar >

Default modifier for StepperSubcycling.

The default modifier provides no-op functionality for the modifier. See StepperSubcyclingModifierBase for details on the algorithm.

Applications can copy this implementation, rename, implement their action, and set on the stepper to get app-specific functionality.

Definition at line 31 of file Tempus_StepperSubcyclingModifierDefault.hpp.

Constructor & Destructor Documentation

◆ StepperSubcyclingModifierDefault()

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

Constructor.

Definition at line 37 of file Tempus_StepperSubcyclingModifierDefault.hpp.

◆ ~StepperSubcyclingModifierDefault()

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

Destructor.

Definition at line 40 of file Tempus_StepperSubcyclingModifierDefault.hpp.

Member Function Documentation

◆ modify()

template<class Scalar >
virtual void Tempus::StepperSubcyclingModifierDefault< Scalar >::modify ( Teuchos::RCP< SolutionHistory< Scalar > >  ,
Teuchos::RCP< StepperSubcycling< Scalar > >  ,
const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlinevirtual

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