Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Tempus::TimeStepControlStrategyComposite< Scalar > Class Template Reference

TimeStepControlStrategyComposite loops over a vector of TimeStepControlStrategies. More...

#include <Tempus_TimeStepControlStrategyComposite.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategyComposite< Scalar >:
Tempus::TimeStepControlStrategy< Scalar >

Public Member Functions

 TimeStepControlStrategyComposite ()
 Constructor.
 
virtual ~TimeStepControlStrategyComposite ()
 Destructor.
 
virtual void setNextTimeStep (const TimeStepControl< Scalar > &tsc, Teuchos::RCP< SolutionHistory< Scalar > > sh, Status &integratorStatus) override
 Determine the time step size.
 
- Public Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
 TimeStepControlStrategy ()
 Constructor.
 
virtual ~TimeStepControlStrategy ()
 Destructor.
 
virtual void setNextTimeStep (const TimeStepControl< Scalar > &, Teuchos::RCP< SolutionHistory< Scalar > >, Status &)
 Set the time step size.
 
virtual void initialize () const
 
virtual bool isInitialized ()
 
virtual void checkInitialized ()
 
virtual void setName (std::string s)
 
virtual std::string getStrategyType () const
 
virtual std::string getStepType () const
 
virtual std::string getName () const
 
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const
 Return ParameterList with current values.
 

Overridden from Teuchos::Describable

std::vector< Teuchos::RCP< TimeStepControlStrategy< Scalar > > > strategies_
 
std::string description () const override
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
 
void addStrategy (const Teuchos::RCP< TimeStepControlStrategy< Scalar > > &strategy)
 Append strategy to the composite list.
 
virtual int size () const
 Size of composite list.
 
virtual std::vector< Teuchos::RCP< TimeStepControlStrategy< Scalar > > > getStrategies () const
 Return composite list.
 
void clearStrategies ()
 Clear the composite list.
 
virtual void initialize () const override
 
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const override
 Return ParameterList with current values.
 

Additional Inherited Members

- Protected Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
virtual void setStrategyType (std::string s)
 
virtual void setStepType (std::string s)
 
- Protected Attributes inherited from Tempus::TimeStepControlStrategy< Scalar >
std::string strategyType_
 Strategy type.
 
std::string stepType_
 Step Type - "Constant" or "Variable".
 
std::string name_
 Name of strategy.
 
bool isInitialized_
 Bool if strategy is initialized.
 

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategyComposite< Scalar >

TimeStepControlStrategyComposite loops over a vector of TimeStepControlStrategies.

Essentially, this is an and case if each strategies do a min $ \Delta t = \min_{i \leq N} \{ \Delta t_i \}$

The assumption is that each strategy will simply update (or override) the step size dt with metadata->setDt(dt) sequentially.

Examples of TimeStepControlStrategy:

Note: The ordering in the TimeStepControlStrategyComposite list is very important. The final TimeStepControlStrategy from the composite could negate all previous step size updates.

Definition at line 42 of file Tempus_TimeStepControlStrategyComposite.hpp.

Constructor & Destructor Documentation

◆ TimeStepControlStrategyComposite()

template<class Scalar >
Tempus::TimeStepControlStrategyComposite< Scalar >::TimeStepControlStrategyComposite ( )
inline

Constructor.

Definition at line 48 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ ~TimeStepControlStrategyComposite()

template<class Scalar >
virtual Tempus::TimeStepControlStrategyComposite< Scalar >::~TimeStepControlStrategyComposite ( )
inlinevirtual

Destructor.

Definition at line 56 of file Tempus_TimeStepControlStrategyComposite.hpp.

Member Function Documentation

◆ setNextTimeStep()

template<class Scalar >
virtual void Tempus::TimeStepControlStrategyComposite< Scalar >::setNextTimeStep ( const TimeStepControl< Scalar > &  tsc,
Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Status integratorStatus 
)
inlineoverridevirtual

Determine the time step size.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 59 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ description()

template<class Scalar >
std::string Tempus::TimeStepControlStrategyComposite< Scalar >::description ( ) const
inlineoverride

Definition at line 69 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ describe()

template<class Scalar >
void Tempus::TimeStepControlStrategyComposite< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
inlineoverride

Definition at line 72 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ addStrategy()

template<class Scalar >
void Tempus::TimeStepControlStrategyComposite< Scalar >::addStrategy ( const Teuchos::RCP< TimeStepControlStrategy< Scalar > > &  strategy)
inline

Append strategy to the composite list.

Definition at line 101 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ size()

template<class Scalar >
virtual int Tempus::TimeStepControlStrategyComposite< Scalar >::size ( ) const
inlinevirtual

Size of composite list.

Definition at line 117 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ getStrategies()

template<class Scalar >
virtual std::vector< Teuchos::RCP< TimeStepControlStrategy< Scalar > > > Tempus::TimeStepControlStrategyComposite< Scalar >::getStrategies ( ) const
inlinevirtual

Return composite list.

Definition at line 121 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ clearStrategies()

template<class Scalar >
void Tempus::TimeStepControlStrategyComposite< Scalar >::clearStrategies ( )
inline

Clear the composite list.

Definition at line 124 of file Tempus_TimeStepControlStrategyComposite.hpp.

◆ initialize()

template<class Scalar >
virtual void Tempus::TimeStepControlStrategyComposite< Scalar >::initialize ( ) const
inlineoverridevirtual

◆ getValidParameters()

template<class Scalar >
virtual Teuchos::RCP< const Teuchos::ParameterList > Tempus::TimeStepControlStrategyComposite< Scalar >::getValidParameters ( ) const
inlineoverridevirtual

Return ParameterList with current values.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 155 of file Tempus_TimeStepControlStrategyComposite.hpp.

Member Data Documentation

◆ strategies_

template<class Scalar >
std::vector<Teuchos::RCP<TimeStepControlStrategy<Scalar > > > Tempus::TimeStepControlStrategyComposite< Scalar >::strategies_
private

Definition at line 177 of file Tempus_TimeStepControlStrategyComposite.hpp.


The documentation for this class was generated from the following file: