Tempus
Version of the Day
Time Integration
Main Page
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Pages
Tempus_StepperOperatorSplitObserver.hpp
Go to the documentation of this file.
1
// @HEADER
2
// ****************************************************************************
3
// Tempus: Copyright (2017) Sandia Corporation
4
//
5
// Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6
// ****************************************************************************
7
// @HEADER
8
9
#ifndef Tempus_StepperOperatorSplitObserver_hpp
10
#define Tempus_StepperOperatorSplitObserver_hpp
11
12
#include "Tempus_SolutionHistory.hpp"
13
14
15
namespace
Tempus {
16
17
// Forward Declaration for recursive includes (this Observer <--> Stepper)
18
template
<
class
Scalar>
class
StepperOperatorSplit;
19
20
/** \brief StepperOperatorSplitObserver class for StepperOperatorSplit.
21
*
22
* This is a means for application developers to perform tasks
23
* during the time steps, e.g.,
24
* - Compute specific quantities
25
* - Output information
26
* - "Massage" the working solution state
27
* - ...
28
*
29
* <b>Design Considerations</b>
30
* - StepperOperatorSplitObserver is not stateless! Developers may touch the
31
* solution state! Developers need to be careful not to break the
32
* restart (checkpoint) capability.
33
*/
34
template
<
class
Scalar>
35
class
StepperOperatorSplitObserver
36
:
virtual
public
Tempus::StepperObserver
<Scalar>
37
{
38
public
:
39
40
/// Constructor
41
StepperOperatorSplitObserver
(){}
42
43
/// Destructor
44
virtual
~StepperOperatorSplitObserver
(){}
45
46
/// Observe Stepper at beginning of takeStep.
47
virtual
void
observeBeginTakeStep
(
48
Teuchos::RCP<
SolutionHistory<Scalar>
>
/* sh */
,
49
Stepper<Scalar>
&
/* stepper */
){}
50
51
/// Observe Stepper before index subStepper->takeStep()
52
virtual
void
observeBeforeStepper
(
int
/* index */
,
53
Teuchos::RCP<
SolutionHistory<Scalar>
>
/* sh */
,
54
StepperOperatorSplit<Scalar>
&
/* stepperOS */
){}
55
56
/// Observe Stepper after index subStepper->takeStep()
57
virtual
void
observeAfterStepper
(
int
/* index */
,
58
Teuchos::RCP<
SolutionHistory<Scalar>
>
/* sh */
,
59
StepperOperatorSplit<Scalar>
&
/* stepperOS */
){}
60
61
/// Observe Stepper at end of takeStep.
62
virtual
void
observeEndTakeStep
(
63
Teuchos::RCP<
SolutionHistory<Scalar>
>
/* sh */
,
64
Stepper<Scalar>
&
/* stepperOS */
){}
65
};
66
}
// namespace Tempus
67
#endif // Tempus_StepperOperatorSplitObserver_hpp
Tempus::StepperOperatorSplitObserver::StepperOperatorSplitObserver
StepperOperatorSplitObserver()
Constructor.
Definition:
Tempus_StepperOperatorSplitObserver.hpp:41
Tempus::StepperOperatorSplit
OperatorSplit stepper loops through the Stepper list.
Definition:
Tempus_StepperOperatorSplit_decl.hpp:39
Tempus::Stepper
Thyra Base interface for time steppers.
Definition:
Tempus_Integrator.hpp:24
Tempus::StepperOperatorSplitObserver::observeBeforeStepper
virtual void observeBeforeStepper(int, Teuchos::RCP< SolutionHistory< Scalar > >, StepperOperatorSplit< Scalar > &)
Observe Stepper before index subStepper->takeStep()
Definition:
Tempus_StepperOperatorSplitObserver.hpp:52
Tempus::StepperOperatorSplitObserver
StepperOperatorSplitObserver class for StepperOperatorSplit.
Definition:
Tempus_StepperOperatorSplitObserver.hpp:35
Tempus::StepperObserver
StepperObserver class for Stepper class.
Definition:
Tempus_StepperObserver.hpp:38
Tempus::SolutionHistory
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Definition:
Tempus_Integrator.hpp:25
Tempus::StepperOperatorSplitObserver::observeAfterStepper
virtual void observeAfterStepper(int, Teuchos::RCP< SolutionHistory< Scalar > >, StepperOperatorSplit< Scalar > &)
Observe Stepper after index subStepper->takeStep()
Definition:
Tempus_StepperOperatorSplitObserver.hpp:57
Tempus::StepperOperatorSplitObserver::observeEndTakeStep
virtual void observeEndTakeStep(Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &)
Observe Stepper at end of takeStep.
Definition:
Tempus_StepperOperatorSplitObserver.hpp:62
Tempus::StepperOperatorSplitObserver::~StepperOperatorSplitObserver
virtual ~StepperOperatorSplitObserver()
Destructor.
Definition:
Tempus_StepperOperatorSplitObserver.hpp:44
Tempus::StepperOperatorSplitObserver::observeBeginTakeStep
virtual void observeBeginTakeStep(Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &)
Observe Stepper at beginning of takeStep.
Definition:
Tempus_StepperOperatorSplitObserver.hpp:47
src
Tempus_StepperOperatorSplitObserver.hpp
Generated on Fri Jun 5 2020 10:23:08 for Tempus by
1.8.5