Tempus
Version of the Day
Time Integration
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
src
Tempus_StepperNewmarkExplicitAFormModifierXBase.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_StepperNewmarkExplicitAFormModifierXBase_hpp
10
#define Tempus_StepperNewmarkExplicitAFormModifierXBase_hpp
11
12
#include "Tempus_config.hpp"
13
#include "Tempus_SolutionHistory.hpp"
14
#include "
Tempus_StepperNewmarkExplicitAFormAppAction.hpp
"
15
16
namespace
Tempus {
17
35
template
<
class
Scalar>
36
class
StepperNewmarkExplicitAFormModifierXBase
37
:
virtual
public
Tempus::StepperNewmarkExplicitAFormAppAction
<Scalar> {
38
private
:
39
/* \brief Adaptor execute function
40
*
41
* This is an adaptor function to bridge between the AppAction
42
* interface and the ModifierX interface. It is meant to be private
43
* and non-virtual as deriving from this class should only need to
44
* implement the modify function.
45
*
46
* For the ModifierX interface, this adaptor maps the
47
* StepperNewmarkExplicitAFormAppAction::ACTION_LOCATION to the
48
* StepperNewmarkExplicitAFormModifierX::MODIFIERX_TYPE, and only pass the
49
* solution
50
* (\f$x\f$ and/or \f$\dot{x}\f$ and other parameters to the modify
51
* function.
52
*/
53
void
execute
(
Teuchos::RCP
<
SolutionHistory<Scalar>
> sh,
54
Teuchos::RCP
<
StepperNewmarkExplicitAForm<Scalar>
> stepper,
55
const
typename
StepperNewmarkExplicitAFormAppAction
<
56
Scalar>::
ACTION_LOCATION
actLoc)
57
{
58
using
Teuchos::RCP
;
59
60
MODIFIER_TYPE
modType =
X_BEGIN_STEP
;
61
RCP<SolutionState<Scalar> > workingState = sh->getWorkingState();
62
const
Scalar time = workingState->getTime();
63
const
Scalar dt = workingState->getTimeStep();
64
RCP<Thyra::VectorBase<Scalar> > x;
65
66
switch
(actLoc) {
67
case
StepperNewmarkExplicitAFormAppAction<Scalar>::BEGIN_STEP
: {
68
modType =
X_BEGIN_STEP
;
69
x = workingState->getX();
70
break
;
71
}
72
case
StepperNewmarkExplicitAFormAppAction<Scalar>::BEFORE_EXPLICIT_EVAL
: {
73
modType =
X_BEFORE_EXPLICIT_EVAL
;
74
x = workingState->getX();
75
break
;
76
}
77
case
StepperNewmarkExplicitAFormAppAction<Scalar>::AFTER_EXPLICIT_EVAL
: {
78
modType =
X_AFTER_EXPLICIT_EVAL
;
79
x = workingState->getX();
80
break
;
81
}
82
case
StepperNewmarkExplicitAFormAppAction<Scalar>::END_STEP
: {
83
modType =
X_END_STEP
;
84
x = workingState->getX();
85
break
;
86
}
87
default
:
88
TEUCHOS_TEST_FOR_EXCEPTION
(
true
, std::logic_error,
89
"Error - unknown action location.\n"
);
90
}
91
92
this->
modify
(x, time, dt, modType);
93
}
94
95
public
:
97
enum
MODIFIER_TYPE
{
98
X_BEGIN_STEP
,
99
X_BEFORE_EXPLICIT_EVAL
,
100
X_AFTER_EXPLICIT_EVAL
,
101
X_END_STEP
102
};
103
105
virtual
void
modify
(
Teuchos::RCP
<
Thyra::VectorBase<Scalar>
>
/* x */
,
106
const
Scalar
/* time */
,
const
Scalar
/* dt */
,
107
const
MODIFIER_TYPE
modType) = 0;
108
};
109
110
}
// namespace Tempus
111
112
#endif // Tempus_StepperNewmarkExplicitAFormModifierXBase_hpp
Tempus::StepperNewmarkExplicitAFormAppAction
Application Action for StepperNewmarkExplicitAForm.
Definition:
Tempus_StepperNewmarkExplicitAFormAppAction.hpp:34
TEUCHOS_TEST_FOR_EXCEPTION
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Tempus::StepperNewmarkExplicitAFormModifierXBase::X_END_STEP
Modify at the end of the step.
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:101
Tempus::StepperNewmarkExplicitAFormModifierXBase::X_BEFORE_EXPLICIT_EVAL
Modify before the explicit evaluation.
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:99
Tempus::StepperNewmarkExplicitAForm
Newmark Explicit time stepper.
Definition:
Tempus_StepperNewmarkExplicitAForm_decl.hpp:92
Tempus::StepperNewmarkExplicitAFormAppAction< double >::ACTION_LOCATION
ACTION_LOCATION
Indicates the location of application action (see algorithm).
Definition:
Tempus_StepperNewmarkExplicitAFormAppAction.hpp:37
Tempus::StepperNewmarkExplicitAFormModifierXBase::X_AFTER_EXPLICIT_EVAL
Modify after the explicit evaluation.
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:100
Thyra::VectorBase
Tempus::SolutionHistory
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Definition:
Tempus_Integrator.hpp:27
Tempus::StepperNewmarkExplicitAFormModifierXBase::X_BEGIN_STEP
Modify at the beginning of the step.
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:98
Tempus::StepperNewmarkExplicitAFormModifierXBase::modify
virtual void modify(Teuchos::RCP< Thyra::VectorBase< Scalar > >, const Scalar, const Scalar, const MODIFIER_TYPE modType)=0
Modify solution based on the MODIFIER_TYPE.
Tempus::StepperNewmarkExplicitAFormModifierXBase::execute
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperNewmarkExplicitAForm< Scalar > > stepper, const typename StepperNewmarkExplicitAFormAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for NewmarkExplicitAForm Stepper.
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:53
Tempus_StepperNewmarkExplicitAFormAppAction.hpp
Tempus::StepperNewmarkExplicitAFormModifierXBase< double >::MODIFIER_TYPE
MODIFIER_TYPE
Indicates the location of application action (see algorithm).
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:97
Teuchos::RCP
Tempus::StepperNewmarkExplicitAFormModifierXBase
Base ModifierX for StepperNewmarkExplicitAForm.
Definition:
Tempus_StepperNewmarkExplicitAFormModifierXBase.hpp:36
Generated on Thu Apr 25 2024 09:24:36 for Tempus by
1.8.5