Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperSubcycling_decl.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_StepperSubcycling_decl_hpp
10#define Tempus_StepperSubcycling_decl_hpp
11
12#include "Tempus_config.hpp"
13#include "Tempus_StepperExplicit.hpp"
15#include "Tempus_IntegratorBasic.hpp"
16
17
18namespace Tempus {
19
53template<class Scalar>
54class StepperSubcycling : virtual public Tempus::Stepper<Scalar>
55{
56public:
57
64
67 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
68 const Teuchos::RCP<IntegratorBasic<Scalar> >& integrator,
69 bool useFSAL,
70 std::string ICConsistency,
71 bool ICConsistencyCheck,
72 const Teuchos::RCP<StepperSubcyclingAppAction<Scalar> >& stepperSCAppAction);
73
75
76 virtual void setModel(
77 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel);
78
79 virtual void setNonConstModel(
80 const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> >& appModel);
81
82 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
83 getModel() const {return scIntegrator_->getStepper()->getModel();}
84
85 virtual void setAppAction(
86 Teuchos::RCP<StepperSubcyclingAppAction<Scalar> > appAction = Teuchos::null);
87
88 virtual Teuchos::RCP<StepperSubcyclingAppAction<Scalar> > getAppAction() const
89 { return stepperSCAppAction_; }
90
92 virtual void initialize();
93
94 virtual Scalar getInitTimeStep(
95 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory) const;
96
98 virtual void setInitialConditions (
99 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
100
102 // thus a no-op for explicit steppers.
103 virtual void setInitialGuess(
104 Teuchos::RCP<const Thyra::VectorBase<Scalar> > initial_guess);
105
106 virtual void setSolver(
107 Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > solver = Teuchos::null);
108
109 virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > getSolver() const;
110
112 virtual void takeStep(
113 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
114
116 virtual Teuchos::RCP<Tempus::StepperState<Scalar> > getDefaultStepperState();
117
118 virtual bool isExplicit() const;
119 virtual bool isImplicit() const;
120 virtual bool isExplicitImplicit() const;
121 virtual bool isOneStepMethod() const;
122 virtual bool isMultiStepMethod() const;
123
124 virtual Scalar getOrder() const;
125 virtual Scalar getOrderMin() const;
126 virtual Scalar getOrderMax() const;
127 virtual OrderODE getOrderODE() const;
129
130 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
131
133
134 virtual void describe(Teuchos::FancyOStream & out,
135 const Teuchos::EVerbosityLevel verbLevel) const;
137
139
140 virtual void setSubcyclingStepper(Teuchos::RCP<Stepper<Scalar> > stepper);
141 virtual void setSubcyclingMinTimeStep(Scalar MinTimeStep);
142 virtual void setSubcyclingInitTimeStep(Scalar InitTimeStep);
143 virtual void setSubcyclingMaxTimeStep(Scalar MaxTimeStep);
144 virtual void setSubcyclingMaxFailures(int MaxFailures);
145 virtual void setSubcyclingMaxConsecFailures(int MaxConsecFailures);
146 virtual void setSubcyclingScreenOutputIndexInterval(int i);
147 virtual void setSubcyclingScreenOutputIndexList(std::string s);
149 Teuchos::RCP<TimeStepControlStrategy<Scalar> > tscs);
151 Teuchos::RCP<IntegratorObserver<Scalar> > obs);
152 virtual void setSubcyclingPrintDtChanges(bool printDtChanges);
154
156
157 virtual Teuchos::RCP<const Stepper<Scalar> > getSubcyclingStepper() const;
158 virtual Scalar getSubcyclingMinTimeStep() const;
159 virtual Scalar getSubcyclingInitTimeStep() const;
160 virtual Scalar getSubcyclingMaxTimeStep() const;
161 virtual std::string getSubcyclingStepType() const;
162 virtual int getSubcyclingMaxFailures() const;
163 virtual int getSubcyclingMaxConsecFailures() const;
164 virtual int getSubcyclingScreenOutputIndexInterval() const;
165 virtual std::string getSubcyclingScreenOutputIndexList() const;
166 virtual Teuchos::RCP<TimeStepControlStrategy<Scalar> >
168 virtual Teuchos::RCP<IntegratorObserver<Scalar> >
170 virtual bool getSubcyclingPrintDtChanges() const;
172
173protected:
174
175 Teuchos::RCP<StepperSubcyclingAppAction<Scalar> > stepperSCAppAction_;
176 Teuchos::RCP<IntegratorBasic<Scalar> > scIntegrator_;
177
178};
179
180
182// ------------------------------------------------------------------------
183template<class Scalar>
184Teuchos::RCP<StepperSubcycling<Scalar> >
186 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
187 Teuchos::RCP<Teuchos::ParameterList> pl);
188
189
190} // namespace Tempus
191
192#endif // Tempus_StepperSubcycling_decl_hpp
IntegratorObserver class for time integrators.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Application Action for StepperSubcycling.
virtual void setSubcyclingStepper(Teuchos::RCP< Stepper< Scalar > > stepper)
virtual Teuchos::RCP< IntegratorObserver< Scalar > > getSubcyclingIntegratorObserver() const
virtual Scalar getInitTimeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const
virtual void setSubcyclingPrintDtChanges(bool printDtChanges)
virtual Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > getAppAction() const
virtual Scalar getSubcyclingMaxTimeStep() const
Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > stepperSCAppAction_
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const
virtual void initialize()
Initialize during construction and after changing input parameters.
virtual Teuchos::RCP< const Stepper< Scalar > > getSubcyclingStepper() const
virtual int getSubcyclingScreenOutputIndexInterval() const
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual void setAppAction(Teuchos::RCP< StepperSubcyclingAppAction< Scalar > > appAction=Teuchos::null)
virtual void setSolver(Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver=Teuchos::null)
Set solver.
virtual void setSubcyclingMaxTimeStep(Scalar MaxTimeStep)
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
virtual void setNonConstModel(const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)
virtual void setSubcyclingIntegratorObserver(Teuchos::RCP< IntegratorObserver< Scalar > > obs)
virtual void setSubcyclingInitTimeStep(Scalar InitTimeStep)
Teuchos::RCP< IntegratorBasic< Scalar > > scIntegrator_
virtual Scalar getSubcyclingInitTimeStep() const
virtual Scalar getSubcyclingMinTimeStep() const
virtual std::string getSubcyclingStepType() const
virtual void setInitialGuess(Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess)
Pass initial guess to Newton solver (only relevant for implicit solvers)
virtual void setSubcyclingMinTimeStep(Scalar MinTimeStep)
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver() const
Get solver.
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
virtual void setSubcyclingScreenOutputIndexInterval(int i)
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
virtual Teuchos::RCP< TimeStepControlStrategy< Scalar > > getSubcyclingTimeStepControlStrategy() const
virtual std::string getSubcyclingScreenOutputIndexList() const
virtual void setSubcyclingMaxFailures(int MaxFailures)
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions, make them consistent, and set needed memory.
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Get a default (initial) StepperState.
virtual void setSubcyclingMaxConsecFailures(int MaxConsecFailures)
virtual void setSubcyclingScreenOutputIndexList(std::string s)
virtual void setSubcyclingTimeStepControlStrategy(Teuchos::RCP< TimeStepControlStrategy< Scalar > > tscs)
Thyra Base interface for time steppers.
TimeStepControlStrategy class for TimeStepControl.
Teuchos::RCP< StepperSubcycling< Scalar > > createStepperSubcycling(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, Teuchos::RCP< Teuchos::ParameterList > pl)
Nonmember constructor - ModelEvaluator and ParameterList.