#include <Tempus_StepperBDF2ModifierXBase.hpp>

Inheritance diagram for Tempus::StepperBDF2ModifierXBase< Scalar >:

Public Types
enum	MODIFIER_TYPE { X_BEGIN_STEP, X_BEFORE_SOLVE, X_AFTER_SOLVE, X_END_STEP }
	Indicates the location of application action (see algorithm). More...

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

Public Member Functions
virtual void	modify (Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
	Modify solution based on the MODIFIER_TYPE. More...

Public Member Functions inherited from Tempus::StepperBDF2AppAction< Scalar >
	StepperBDF2AppAction ()
	Constructor. More...

virtual	~StepperBDF2AppAction ()
	Destructor. More...

Private Member Functions
void	execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperBDF2< Scalar > > stepper, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)
	Execute application action for BDF2 Stepper. More...

Detailed Description

template<class Scalar>
class Tempus::StepperBDF2ModifierXBase< Scalar >

Base ModifierX for StepperBDF2.

This class provides a means to modify just the solution values (i.e., $x$ and $dot{x}$ ), and nothing else, but time and timestep are also provided.

Users deriving from this class can access and change the solution during the timestep (e.g., limiting the solution for monoticity). It is expected that the user knows what changes are allowable without affecting the Stepper correctness, performance, accuracy and stability (i.e., USER BEWARE!!).

The locations of the StepperBDF2ModifierXBase::MODIFIER_TYPE which correspond to the AppAction calls (StepperBDF2AppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperBDF2.

Definition at line 38 of file Tempus_StepperBDF2ModifierXBase.hpp.

Member Enumeration Documentation

template<class Scalar>

enum Tempus::StepperBDF2ModifierXBase::MODIFIER_TYPE

Indicates the location of application action (see algorithm).

Enumerator
X_BEGIN_STEP	Modify at the beginning of the step.
X_BEFORE_SOLVE	Modify before the implicit solve.
X_AFTER_SOLVE	Modify after the implicit solve.
X_END_STEP	Modify at the end of the step.

Definition at line 105 of file Tempus_StepperBDF2ModifierXBase.hpp.

Member Function Documentation

template<class Scalar>

void Tempus::StepperBDF2ModifierXBase< Scalar >::execute	(	Teuchos::RCP< SolutionHistory< Scalar > >	sh,
		Teuchos::RCP< StepperBDF2< Scalar > >	stepper,
		const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION	actLoc
	)

inlineprivatevirtual

Execute application action for BDF2 Stepper.

Implements Tempus::StepperBDF2AppAction< Scalar >.

Definition at line 56 of file Tempus_StepperBDF2ModifierXBase.hpp.

template<class Scalar>

virtual void Tempus::StepperBDF2ModifierXBase< Scalar >::modify	(	Teuchos::RCP< Thyra::VectorBase< Scalar > >	,
		const Scalar	,
		const Scalar	,
		const MODIFIER_TYPE	modType
	)

pure virtual

Modify solution based on the MODIFIER_TYPE.

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

Tempus_StepperBDF2ModifierXBase.hpp

Public Types

Public Member Functions

Private Member Functions

Detailed Description

template<class Scalar> class Tempus::StepperBDF2ModifierXBase< Scalar >

Member Enumeration Documentation

Member Function Documentation

template<class Scalar>
class Tempus::StepperBDF2ModifierXBase< Scalar >