Subcycling time stepper. More...

#include <Tempus_StepperSubcycling_decl.hpp>

Inheritance diagram for Tempus::StepperSubcycling< Scalar >:

Public Member Functions
	StepperSubcycling ()
	Default constructor. More...

	StepperSubcycling (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const Teuchos::RCP< StepperSubcyclingObserver< Scalar > > &obs, const Teuchos::RCP< IntegratorBasic< Scalar > > &integrator, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck)
	Constructor. More...

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const

Basic stepper methods
virtual void	setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)

virtual void	setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getModel ()

virtual void	setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)
	Set Observer. More...

virtual Teuchos::RCP < StepperObserver< Scalar > >	getObserver () const
	Get Observer. More...

virtual void	initialize ()
	Initialize during construction and after changing input parameters. More...

virtual Scalar	getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const

virtual void	setInitialConditions (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
	Set the initial conditions, make them consistent, and set needed memory. More...

virtual void	setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
	Pass initial guess to Newton solver (only relevant for implicit solvers) More...

virtual void	setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null)
	Set solver. More...

virtual Teuchos::RCP < Thyra::NonlinearSolverBase < Scalar > >	getSolver () const
	Get solver. 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 bool	isExplicit () const

virtual bool	isImplicit () const

virtual bool	isExplicitImplicit () const

virtual bool	isOneStepMethod () const

virtual bool	isMultiStepMethod () const

virtual Scalar	getOrder () const

virtual Scalar	getOrderMin () const

virtual Scalar	getOrderMax () const

virtual OrderODE	getOrderODE () const

Overridden from Teuchos::Describable
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Functions to set the subcycling stepper.
virtual void	setSubcyclingStepper (Teuchos::RCP< Stepper< Scalar > > stepper)

virtual void	setSubcyclingMinTimeStep (Scalar MinTimeStep)

virtual void	setSubcyclingInitTimeStep (Scalar InitTimeStep)

virtual void	setSubcyclingMaxTimeStep (Scalar MaxTimeStep)

virtual void	setSubcyclingStepType (std::string StepType)

virtual void	setSubcyclingMaxFailures (int MaxFailures)

virtual void	setSubcyclingMaxConsecFailures (int MaxConsecFailures)

virtual void	setSubcyclingScreenOutputIndexInterval (int i)

virtual void	setSubcyclingTimeStepControlStrategy (Teuchos::RCP< TimeStepControlStrategy< Scalar > > tscs)

Public Member Functions inherited from Tempus::Stepper< Scalar >
void	setStepperType (std::string s)

std::string	getStepperType () const

void	setUseFSAL (bool a)

bool	getUseFSAL () const

virtual bool	getUseFSALDefault () const

void	setICConsistency (std::string s)

std::string	getICConsistency () const

virtual std::string	getICConsistencyDefault () const

void	setICConsistencyCheck (bool c)

bool	getICConsistencyCheck () const

virtual bool	getICConsistencyCheckDefault () const

virtual std::string	description () const

virtual void	createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >)

Public Attributes
bool	isInitialized_ = false

Protected Attributes
Teuchos::RCP < StepperSubcyclingObserver < Scalar > >	stepperSCObserver_

Teuchos::RCP< IntegratorBasic < Scalar > >	scIntegrator_

Detailed Description

template<class Scalar>
class Tempus::StepperSubcycling< Scalar >

Subcycling time stepper.

This stepper wraps an IntegratorBasic object to perform the subcycling, thus it has all the capbilities of an IntegratorBasic with the following specializations and defaults:

Main Integrator operates independently from subcycling Stepper, and can be driven by another physics.
Need separate TimeStepControl for the subcycling so it can be driven by the physics (e.g., variable time stepping).
Finish the subcycling exactly on the full timestep.
No solution I/O within the subcycling.
No restart capability within subcycling, but still have restart capability from the full timestep.
Do not need to keep a solution history of the subcycling.

Definition at line 36 of file Tempus_StepperSubcycling_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::StepperSubcycling< Scalar >::StepperSubcycling ( )

Default constructor.

Requires subsequent setModel() and initialize() call before calling takeStep().

Definition at line 25 of file Tempus_StepperSubcycling_impl.hpp.

template<class Scalar >

Tempus::StepperSubcycling< Scalar >::StepperSubcycling	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		const Teuchos::RCP< StepperSubcyclingObserver< Scalar > > &	obs,
		const Teuchos::RCP< IntegratorBasic< Scalar > > &	integrator,
		bool	useFSAL,
		std::string	ICConsistency,
		bool	ICConsistencyCheck
	)

Constructor.

Definition at line 76 of file Tempus_StepperSubcycling_impl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::StepperSubcycling< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

virtual

Definition at line 445 of file Tempus_StepperSubcycling_impl.hpp.

template<class Scalar >

Teuchos::RCP< Tempus::StepperState< Scalar > > Tempus::StepperSubcycling< Scalar >::getDefaultStepperState ( )

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.

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

template<class Scalar> class Tempus::StepperSubcycling< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::StepperSubcycling< Scalar >