Base observer for StepperBackwardEuler. More...

#include <Tempus_StepperBackwardEulerObserverBase.hpp>

Inheritance diagram for Tempus::StepperBackwardEulerObserverBase< Scalar >:

Public Member Functions
virtual void	observe (Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperBackwardEuler< Scalar > >, const typename StepperBackwardEulerAppAction< Scalar >::ACTION_LOCATION actLoc)=0
	Observe BackwardEuler Stepper. More...

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

virtual	~StepperBackwardEulerAppAction ()
	Destructor. More...

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

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

Detailed Description

template<class Scalar>
class Tempus::StepperBackwardEulerObserverBase< Scalar >

Base observer for StepperBackwardEuler.

This class provides a means to observe values (e.g., solution variables through SolutionHistory, and stepper member data through the Stepper), and cannot modify them.

Users deriving from this class can observer a lot of data, and it is expected that users will NOT modify any of that data. If the user wishes to modify the solution and/or stepper data during the Stepper::takeStep, they should use the Modifier class (with care!).

Below is the BackwardEuler algorithm with the locations of the observe calls italicized.

$\begin{algorithm} \renewcommand{\thealgorithm}{} \caption{DIRK Backward Euler with observe calls indicated.} \begin{algorithmic}[1] \State \quad {\it observer.observe(solutionHistory, stepper, BEGIN\_STEP)} \State Compute the predictor (e.g., apply stepper to $x_n$). \State \quad {\it observer.observe(solutionHistory, stepper, BEFORE\_SOLVE)} \State Solve $\mathcal{F}_n(\dot{x}=(x_n-x_{n-1})/\Delta t_n, x_n, t_n)=0$ for $x_n$ \State \quad {\it observer.observe(solutionHistory, stepper, AFTER\_SOLVE)} \State $\dot{x}_n \leftarrow (x_n-x_{n-1})/\Delta t_n$ \State \quad {\it observer.observe(solutionHistory, stepper, END\_STEP)} \end{algorithmic} \end{algorithm}$

Definition at line 48 of file Tempus_StepperBackwardEulerObserverBase.hpp.

Member Function Documentation

template<class Scalar>

void Tempus::StepperBackwardEulerObserverBase< Scalar >::execute	(	Teuchos::RCP< SolutionHistory< Scalar > >	sh,
		Teuchos::RCP< StepperBackwardEuler< Scalar > >	stepper,
		const typename StepperBackwardEulerAppAction< Scalar >::ACTION_LOCATION	actLoc
	)

inlineprivatevirtual

Execute application action for BackwardEuler Stepper.

Implements Tempus::StepperBackwardEulerAppAction< Scalar >.

Definition at line 63 of file Tempus_StepperBackwardEulerObserverBase.hpp.

template<class Scalar>

virtual void Tempus::StepperBackwardEulerObserverBase< Scalar >::observe	(	Teuchos::RCP< const SolutionHistory< Scalar > >	,
		Teuchos::RCP< const StepperBackwardEuler< Scalar > >	,
		const typename StepperBackwardEulerAppAction< Scalar >::ACTION_LOCATION	actLoc
	)

pure virtual

Observe BackwardEuler Stepper.

Implemented in Tempus_Unit_Test::StepperBackwardEulerObserverTest, and Tempus::StepperBackwardEulerObserverDefault< Scalar >.

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

http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_StepperBackwardEulerObserverBase.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperBackwardEulerObserverBase< Scalar >

Member Function Documentation

template<class Scalar>
class Tempus::StepperBackwardEulerObserverBase< Scalar >