Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_WrapperModelEvaluatorPairIMEX_Basic_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_ModelEvaluatorPairIMEX_Basic_decl_hpp
10#define Tempus_ModelEvaluatorPairIMEX_Basic_decl_hpp
11
12#include "Tempus_config.hpp"
14#include "Thyra_StateFuncModelEvaluatorBase.hpp"
15
16
17namespace Tempus {
18
38template <typename Scalar>
41{
42public:
43
46 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& explicitModel,
47 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& implicitModel)
48 : timeDer_(Teuchos::null)
49 {
50 setExplicitModel(explicitModel);
51 setImplicitModel(implicitModel);
52 initialize();
53 }
54
57
59 virtual void initialize();
60
62
63 virtual void setAppModel(
64 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & me);
65 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
66 getAppModel() const;
67
69 virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs)
70 { wrapperImplicitInArgs_.setArgs(inArgs); }
71
73 virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> getInArgs()
74 { return wrapperImplicitInArgs_; }
75
77 virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs)
78 { wrapperImplicitOutArgs_.setArgs(outArgs); }
79
81 virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar> getOutArgs()
82 { return wrapperImplicitOutArgs_; }
83
85 virtual void setForSolve(Teuchos::RCP<TimeDerivative<Scalar> > timeDer,
86 Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs,
87 Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs,
88 EVALUATION_TYPE /* evaluationType */ = SOLVE_FOR_X)
89 {
90 timeDer_ = timeDer;
91 wrapperImplicitInArgs_.setArgs(inArgs);
92 wrapperImplicitOutArgs_.setArgs(outArgs);
93 }
94
96
98
99
100 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
101 get_x_space() const;
102
104 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
105 get_g_space(int i) const;
106
108 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
109 get_p_space(int i) const;
111
113 virtual void setExplicitModel(
114 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & model )
115 { explicitModel_ = model; }
116 virtual void setImplicitModel(
117 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & model )
118 { implicitModel_ = model; }
119 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
121 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
124
126
127 virtual Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const
128 { return implicitModel_->create_W_op(); }
129
130 Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> >
131 get_W_factory() const { return implicitModel_->get_W_factory(); }
132
133 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
134 get_f_space() const { return explicitModel_->get_f_space(); }
135
136 virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
137 virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
138 virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar>createOutArgsImpl() const;
139
140 virtual void evalModelImpl(
141 const Thyra::ModelEvaluatorBase::InArgs<Scalar> & in,
142 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> & out) const;
144
145protected:
146
149
151 void setup(
152 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& explicitModel,
153 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& implicitModel)
154 {
155 setExplicitModel(explicitModel);
156 setImplicitModel(implicitModel);
157 initialize();
158 }
159
160protected:
161
162 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > explicitModel_;
163 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > implicitModel_;
164
165 Teuchos::RCP<TimeDerivative<Scalar> > timeDer_;
166 Thyra::ModelEvaluatorBase::InArgs<Scalar> wrapperImplicitInArgs_;
167 Thyra::ModelEvaluatorBase::OutArgs<Scalar> wrapperImplicitOutArgs_;
168};
169
170} // namespace Tempus
171
172#endif // Tempus_ModelEvaluatorPairIMEX_Basic_decl_hpp
ModelEvaluator pair for implicit and explicit (IMEX) evaulations.
virtual Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
virtual void setImplicitModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)
WrapperModelEvaluatorPairIMEX_Basic()
Default constructor – only allowed for derived classes.
virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs)
Set InArgs the wrapper ModelEvalutor.
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getExplicitModel() const
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > implicitModel_
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > getInArgs()
Get InArgs the wrapper ModelEvalutor.
virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs)
Set OutArgs the wrapper ModelEvalutor.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int i) const
Get the g space.
virtual Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
virtual void setAppModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)
Set the underlying application ModelEvaluator.
virtual void initialize()
Initialize after setting member data.
virtual void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &in, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &out) const
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAppModel() const
Get the underlying application ModelEvaluator.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Get the x-solution space.
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > explicitModel_
virtual void setForSolve(Teuchos::RCP< TimeDerivative< Scalar > > timeDer, Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs, Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs, EVALUATION_TYPE=SOLVE_FOR_X)
Set parameters for application implicit ModelEvaluator solve.
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getImplicitModel() const
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int i) const
Get the p space.
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
virtual void setExplicitModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)
WrapperModelEvaluatorPairIMEX_Basic(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &explicitModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &implicitModel)
Constructor.
virtual Thyra::ModelEvaluatorBase::OutArgs< Scalar > getOutArgs()
Get OutArgs the wrapper ModelEvalutor.
void setup(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &explicitModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &implicitModel)
Setup ME when using default constructor – for derived classes.
ModelEvaluator pair for implicit and explicit (IMEX) evaluations.
EVALUATION_TYPE
EVALUATION_TYPE indicates the evaluation to apply to the implicit ODE.
@ SOLVE_FOR_X
Solve for x and determine xDot from x.