Tempus Version of the Day
Time Integration
|
Newmark Explicit time stepper. More...
#include <Tempus_StepperNewmarkExplicitAForm_decl.hpp>
Public Member Functions | |
StepperNewmarkExplicitAForm () | |
Default constructor. | |
StepperNewmarkExplicitAForm (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, Scalar gamma, const Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > &stepperAppAction) | |
Constructor. | |
virtual Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > | getAppAction () const |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Set the initial conditions and make them consistent. | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Take the specified timestep, dt, and return true if successful. | |
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > | getDefaultStepperState () |
Get a default (initial) StepperState. | |
virtual Scalar | getOrder () const |
virtual Scalar | getOrderMin () const |
virtual Scalar | getOrderMax () const |
virtual Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const |
virtual bool | isExplicit () const |
virtual bool | isImplicit () const |
virtual bool | isExplicitImplicit () const |
virtual bool | isOneStepMethod () const |
virtual bool | isMultiStepMethod () const |
virtual void | setUseFSAL (bool a) |
virtual OrderODE | getOrderODE () const |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
![]() | |
void | setStepperExplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set StepperExplicit member data from the ParameterList. | |
virtual void | setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) |
Set model. | |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const |
Return the application ModelEvaluator. | |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) |
Set solver. | |
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > | getSolver () const |
Get solver. | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > >) |
Pass initial guess to Newton solver (only relevant for implicit solvers) | |
virtual void | evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p) |
Evaluate xDot = f(x,t). | |
virtual void | evaluateExplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xDot, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p) |
Evaluate xDotDot = f(x, xDot, t). | |
![]() | |
virtual std::string | description () const |
void | setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl) |
Set Stepper member data from ParameterList. | |
Teuchos::RCP< Teuchos::ParameterList > | getValidParametersBasic () const |
Add basic parameters to Steppers ParameterList. | |
virtual void | initialize () |
Initialize after construction and changing input parameters. | |
virtual bool | isInitialized () |
True if stepper's member data is initialized. | |
virtual void | checkInitialized () |
Check initialization, and error out on failure. | |
void | setStepperName (std::string s) |
Set the stepper name. | |
std::string | getStepperName () const |
Get the stepper name. | |
std::string | getStepperType () const |
Get the stepper type. The stepper type is used as an identifier for the stepper, and can only be set by the derived Stepper class. | |
void | setUseFSALTrueOnly (bool a) |
void | setUseFSALFalseOnly (bool a) |
bool | getUseFSAL () const |
void | setICConsistency (std::string s) |
std::string | getICConsistency () const |
void | setICConsistencyCheck (bool c) |
bool | getICConsistencyCheck () const |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperX () |
Get Stepper x. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDot () |
Get Stepper xDot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDotDot () |
Get Stepper xDotDot. | |
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > | getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state) |
Get xDotDot from SolutionState or Stepper storage. | |
Overridden from Teuchos::Describable | |
Scalar | gammaDefault_ |
Scalar | gamma_ |
Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > | stepperNewmarkExpAppAction_ |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
virtual bool | isValidSetup (Teuchos::FancyOStream &out) const |
void | predictVelocity (Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const |
void | predictDisplacement (Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &d, const Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const |
void | correctVelocity (Thyra::VectorBase< Scalar > &v, const Thyra::VectorBase< Scalar > &vPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const |
void | setGamma (Scalar gamma) |
virtual void | setAppAction (Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > appAction) |
Additional Inherited Members | |
![]() | |
virtual void | setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x) |
Set x for Stepper storage. | |
virtual void | setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot) |
Set xDot for Stepper storage. | |
virtual void | setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot) |
Set x for Stepper storage. | |
void | setStepperType (std::string s) |
Set the stepper type. | |
![]() | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | appModel_ |
Explicit ODE ModelEvaluator. | |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | inArgs_ |
Thyra::ModelEvaluatorBase::OutArgs< Scalar > | outArgs_ |
![]() | |
bool | useFSAL_ = false |
Use First-Same-As-Last (FSAL) principle. | |
bool | isInitialized_ = false |
True if stepper's member data is initialized. | |
Newmark Explicit time stepper.
This is the specific case of the more general Newmark time stepper where this stepper is explicit (
The governing equation is solved by this stepper is
For the A-form (i.e., solving for the acceleration,
where
Algorithm The algorithm for the Newmark Explicit A-form is
Note that with useFSAL=false
To have them at the same time level, we can use the First-Same-As-Last (FSAL) principle where the function evaulation from the last time step can be used as the first function evalulation of the current step.
The default is to use FSAL (useFSAL=true), but will also work with useFSAL=false. Using useFSAL=true does assume that the solution,
Definition at line 93 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
Tempus::StepperNewmarkExplicitAForm< Scalar >::StepperNewmarkExplicitAForm |
Default constructor.
Definition at line 62 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
Tempus::StepperNewmarkExplicitAForm< Scalar >::StepperNewmarkExplicitAForm | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
Scalar | gamma, | ||
const Teuchos::RCP< StepperNewmarkExplicitAFormAppAction< Scalar > > & | stepperAppAction | ||
) |
Constructor.
Definition at line 74 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
inlinevirtual |
Definition at line 115 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 100 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 237 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
virtual |
Get a default (initial) StepperState.
Provide a StepperState to the SolutionState. This Stepper does not have any special state data, so just provide the base class StepperState with the Stepper description. This can be checked to ensure that the input StepperState can be used by this Stepper.
Implements Tempus::Stepper< Scalar >.
Definition at line 332 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 128 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 132 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 133 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 134 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 138 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 139 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 140 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 142 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 143 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 144 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 145 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
virtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 372 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 342 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperExplicit< Scalar >.
Definition at line 358 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
void Tempus::StepperNewmarkExplicitAForm< Scalar >::predictVelocity | ( | Thyra::VectorBase< Scalar > & | vPred, |
const Thyra::VectorBase< Scalar > & | v, | ||
const Thyra::VectorBase< Scalar > & | a, | ||
const Scalar | dt | ||
) | const |
Definition at line 23 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
void Tempus::StepperNewmarkExplicitAForm< Scalar >::predictDisplacement | ( | Thyra::VectorBase< Scalar > & | dPred, |
const Thyra::VectorBase< Scalar > & | d, | ||
const Thyra::VectorBase< Scalar > & | v, | ||
const Thyra::VectorBase< Scalar > & | a, | ||
const Scalar | dt | ||
) | const |
Definition at line 34 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
void Tempus::StepperNewmarkExplicitAForm< Scalar >::correctVelocity | ( | Thyra::VectorBase< Scalar > & | v, |
const Thyra::VectorBase< Scalar > & | vPred, | ||
const Thyra::VectorBase< Scalar > & | a, | ||
const Scalar | dt | ||
) | const |
Definition at line 51 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
inline |
Definition at line 174 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
virtual |
Definition at line 382 of file Tempus_StepperNewmarkExplicitAForm_impl.hpp.
|
protected |
Definition at line 191 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
protected |
Definition at line 192 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.
|
protected |
Definition at line 193 of file Tempus_StepperNewmarkExplicitAForm_decl.hpp.