Tempus
Version of the Day
Time Integration
|
Newmark time stepper in acceleration form (a-form). More...
#include <Tempus_StepperNewmarkImplicitAForm_decl.hpp>
Public Member Functions | |
StepperNewmarkImplicitAForm () | |
Default constructor. More... | |
StepperNewmarkImplicitAForm (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool zeroInitialGuess, std::string schemeName, Scalar beta, Scalar gamma, const Teuchos::RCP< StepperNewmarkImplicitAFormAppAction< Scalar > > &stepperAppAction) | |
Constructor. More... | |
virtual Scalar | getW_xDotDot_coeff (const Scalar) const |
Return W_xDotxDot_coeff = d(xDotDot)/d(xDotDot). More... | |
virtual Scalar | getAlpha (const Scalar dt) const |
Return alpha = d(xDot)/d(xDotDot). More... | |
virtual Scalar | getBeta (const Scalar dt) const |
Return beta = d(x)/d(xDotDot). More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () 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 | correctDisplacement (Thyra::VectorBase< Scalar > &d, const Thyra::VectorBase< Scalar > &dPred, const Thyra::VectorBase< Scalar > &a, const Scalar dt) const |
void | setSchemeName (std::string schemeName) |
void | setBeta (Scalar beta) |
void | setGamma (Scalar gamma) |
Public Member Functions inherited from Tempus::StepperImplicit< Scalar > | |
Teuchos::RCP < Teuchos::ParameterList > | getValidParametersBasicImplicit () const |
void | setStepperImplicitValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set StepperImplicit member data from the ParameterList. More... | |
void | setStepperSolverValues (Teuchos::RCP< Teuchos::ParameterList > pl) |
Set solver from ParameterList. More... | |
void | setSolverName (std::string i) |
Set the Solver Name. More... | |
std::string | getSolverName () const |
Get the Solver Name. More... | |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const override |
virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > > | getWrapperModel () |
virtual void | setDefaultSolver () |
virtual void | setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) override |
Set solver. More... | |
virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > > | getSolver () const override |
Get solver. More... | |
const Thyra::SolveStatus< Scalar > | solveImplicitODE (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &y=Teuchos::null, const int index=-1) |
Solve implicit ODE, f(x, xDot, t, p) = 0. More... | |
void | evaluateImplicitODE (Teuchos::RCP< Thyra::VectorBase< Scalar > > &f, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p) |
Evaluate implicit ODE residual, f(x, xDot, t, p). More... | |
virtual void | setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess) override |
Pass initial guess to Newton solver (only relevant for implicit solvers) More... | |
virtual void | setZeroInitialGuess (bool zIG) |
virtual bool | getZeroInitialGuess () const |
virtual Scalar | getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &) const override |
Public Member Functions inherited from Tempus::Stepper< Scalar > | |
void | setStepperValues (const Teuchos::RCP< Teuchos::ParameterList > pl) |
Set Stepper member data from ParameterList. More... | |
Teuchos::RCP < Teuchos::ParameterList > | getValidParametersBasic () const |
Add basic parameters to Steppers ParameterList. More... | |
virtual void | initialize () |
Initialize after construction and changing input parameters. More... | |
virtual bool | isInitialized () |
True if stepper's member data is initialized. More... | |
virtual void | checkInitialized () |
Check initialization, and error out on failure. More... | |
void | setStepperName (std::string s) |
Set the stepper name. More... | |
std::string | getStepperName () const |
Get the stepper name. More... | |
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. More... | |
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. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getStepperXDot () |
Get Stepper xDot. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getStepperXDotDot () |
Get Stepper xDotDot. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getStepperXDotDot (Teuchos::RCP< SolutionState< Scalar > > state) |
Get xDotDot from SolutionState or Stepper storage. More... | |
virtual std::string | description () const |
Public Member Functions inherited from Teuchos::Describable | |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > > | |
VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
virtual EVerbosityLevel | getVerbLevel () const |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | setupVerboseObjectSublist (ParameterList *paramList) |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
Public Member Functions inherited from Teuchos::VerboseObjectBase | |
virtual | ~VerboseObjectBase () |
VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () const |
virtual std::string | getLinePrefix () const |
virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
Private Attributes | |
std::string | schemeName_ |
Scalar | beta_ |
Scalar | gamma_ |
Teuchos::RCP < Teuchos::FancyOStream > | out_ |
Teuchos::RCP < StepperNewmarkImplicitAFormAppAction < Scalar > > | stepperNewmarkImpAppAction_ |
Basic stepper methods | |
virtual void | setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) |
Set the model. More... | |
virtual void | setAppAction (Teuchos::RCP< StepperNewmarkImplicitAFormAppAction< Scalar > > appAction) |
virtual Teuchos::RCP < StepperNewmarkImplicitAFormAppAction < Scalar > > | getAppAction () const |
virtual void | setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Set the initial conditions and make them consistent. More... | |
virtual void | takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) |
Take the specified timestep, dt, and return true if successful. More... | |
virtual Teuchos::RCP < Tempus::StepperState< Scalar > > | getDefaultStepperState () |
Get a default (initial) StepperState. More... | |
virtual Scalar | getOrder () const |
virtual Scalar | getOrderMin () const |
virtual Scalar | getOrderMax () 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 |
Overridden from Teuchos::Describable | |
virtual void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
Additional Inherited Members | |
Static Public Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > > | |
static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
static EVerbosityLevel | getDefaultVerbLevel () |
Static Public Member Functions inherited from Teuchos::VerboseObjectBase | |
static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
static RCP< FancyOStream > | getDefaultOStream () |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
Protected Member Functions inherited from Tempus::Stepper< Scalar > | |
virtual void | setStepperX (Teuchos::RCP< Thyra::VectorBase< Scalar > > x) |
Set x for Stepper storage. More... | |
virtual void | setStepperXDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot) |
Set xDot for Stepper storage. More... | |
virtual void | setStepperXDotDot (Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot) |
Set x for Stepper storage. More... | |
void | setStepperType (std::string s) |
Set the stepper type. More... | |
Protected Member Functions inherited from Teuchos::VerboseObject< Stepper< Scalar > > | |
void | initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) |
Protected Member Functions inherited from Teuchos::VerboseObjectBase | |
void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
virtual void | informUpdatedVerbosityState () const |
Protected Attributes inherited from Tempus::StepperImplicit< Scalar > | |
Teuchos::RCP < WrapperModelEvaluator < Scalar > > | wrapperModel_ |
Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > > | solver_ |
Teuchos::RCP< const Thyra::VectorBase< Scalar > > | initialGuess_ |
bool | zeroInitialGuess_ |
std::string | solverName_ |
Protected Attributes inherited from Tempus::Stepper< Scalar > | |
bool | useFSAL_ = false |
Use First-Same-As-Last (FSAL) principle. More... | |
bool | isInitialized_ |
True if stepper's member data is initialized. More... | |
Newmark time stepper in acceleration form (a-form).
Here, we implement the Newmark scheme in predictor/corrector form; see equations (34)-(35) in: A. Mota, W. Klug, M. Ortiz, "Finite element simulation of firearm injury to the human cranium", Computational Mechanics 31(1) 115-121 (2003).
Newmark has two parameters: and , both of which need to be in the range . Newmark can be an explicit or implicit method, depending on the value of the parameter. If , the method is explicit. Regardless of whether the method is implicit or explicit, a linear solve is required. This linear solve can be optimized, however, for the explicit case by lumping the mass matrix. This optimization can be invoked by running "Newmark Explicit d-Form" Stepper through the Piro::TempusSolver class.
Newmark is second order accurate if ; otherwise it is first order accurate. Some additional properties about the Newmark scheme can be found here.
The governing equation solved by this stepper is
For the A-form (i.e., solving for the acceleration, ), we have the following implicit ODE
where and .
Algorithm The algorithm for the Newmark implicit A-form with predictors and correctors is
The First-Same-As-Last (FSAL) principle is not needed with Newmark Implicit A-Form. The default is to set useFSAL=false, however useFSAL=true will also work but have no affect (i.e., no-op).
Definition at line 92 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
Tempus::StepperNewmarkImplicitAForm< Scalar >::StepperNewmarkImplicitAForm | ( | ) |
Default constructor.
Requires subsequent setModel(), setSolver() and initialize() calls before calling takeStep().
Definition at line 172 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
Tempus::StepperNewmarkImplicitAForm< Scalar >::StepperNewmarkImplicitAForm | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | appModel, |
const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > & | solver, | ||
bool | useFSAL, | ||
std::string | ICConsistency, | ||
bool | ICConsistencyCheck, | ||
bool | zeroInitialGuess, | ||
std::string | schemeName, | ||
Scalar | beta, | ||
Scalar | gamma, | ||
const Teuchos::RCP< StepperNewmarkImplicitAFormAppAction< Scalar > > & | stepperAppAction | ||
) |
Constructor.
Definition at line 192 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
virtual |
Set the model.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 220 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
virtual |
Definition at line 156 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
inlinevirtual |
Definition at line 120 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
virtual |
Set the initial conditions and make them consistent.
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 239 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
virtual |
Take the specified timestep, dt, and return true if successful.
Implements Tempus::Stepper< Scalar >.
Definition at line 426 of file Tempus_StepperNewmarkImplicitAForm_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 526 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 135 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 142 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 143 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 145 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 146 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 147 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 151 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 152 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Reimplemented from Tempus::Stepper< Scalar >.
Definition at line 153 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Implements Tempus::Stepper< Scalar >.
Definition at line 154 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Return W_xDotxDot_coeff = d(xDotDot)/d(xDotDot).
Definition at line 158 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Return alpha = d(xDot)/d(xDotDot).
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 160 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
inlinevirtual |
Return beta = d(x)/d(xDotDot).
Implements Tempus::StepperImplicit< Scalar >.
Definition at line 162 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
virtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 592 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 537 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
virtual |
Reimplemented from Tempus::StepperImplicit< Scalar >.
Definition at line 557 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< Scalar >::predictVelocity | ( | Thyra::VectorBase< Scalar > & | vPred, |
const Thyra::VectorBase< Scalar > & | v, | ||
const Thyra::VectorBase< Scalar > & | a, | ||
const Scalar | dt | ||
) | const |
Definition at line 21 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< 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 33 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< 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_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< Scalar >::correctDisplacement | ( | Thyra::VectorBase< Scalar > & | d, |
const Thyra::VectorBase< Scalar > & | dPred, | ||
const Thyra::VectorBase< Scalar > & | a, | ||
const Scalar | dt | ||
) | const |
Definition at line 63 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< Scalar >::setSchemeName | ( | std::string | schemeName | ) |
Definition at line 122 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< Scalar >::setBeta | ( | Scalar | beta | ) |
Definition at line 75 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
void Tempus::StepperNewmarkImplicitAForm< Scalar >::setGamma | ( | Scalar | gamma | ) |
Definition at line 104 of file Tempus_StepperNewmarkImplicitAForm_impl.hpp.
|
private |
Definition at line 200 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
private |
Definition at line 201 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
private |
Definition at line 202 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
private |
Definition at line 204 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.
|
private |
Definition at line 206 of file Tempus_StepperNewmarkImplicitAForm_decl.hpp.