Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
SinCosModel_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_TEST_SINCOS_MODEL_DECL_HPP
10#define TEMPUS_TEST_SINCOS_MODEL_DECL_HPP
11
12#include "Thyra_ModelEvaluator.hpp" // Interface
13#include "Thyra_StateFuncModelEvaluatorBase.hpp" // Implementation
14
15#include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
16#include "Teuchos_ParameterList.hpp"
17
18namespace Tempus_Test {
19
90template<class Scalar>
92 : public Thyra::StateFuncModelEvaluatorBase<Scalar>,
93 public Teuchos::ParameterListAcceptorDefaultBase
94{
95 public:
96
97 // Constructor
98 SinCosModel(Teuchos::RCP<Teuchos::ParameterList> pList = Teuchos::null);
99
100 // Exact solution
101 Thyra::ModelEvaluatorBase::InArgs<Scalar> getExactSolution(double t) const;
102
103 // Exact sensitivity solution
104 Thyra::ModelEvaluatorBase::InArgs<Scalar> getExactSensSolution(int j, double t) const;
105
108
109 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
110 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
111 Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
112 Teuchos::RCP<Thyra::LinearOpWithSolveBase<Scalar> > create_W() const;
113 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
114 Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const;
115 Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
116
117 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int l) const;
118 Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int l) const;
119 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(int j) const;
120
122
125 void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
126 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
128
129private:
130
131 void setupInOutArgs_() const;
132
135 Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
136 void evalModelImpl(
137 const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs_bar,
138 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs_bar
139 ) const;
141
143
144protected:
145 int dim_;
146 int Np_;
147 int np_;
148 int Ng_;
149 int ng_;
150 bool haveIC_;
153 mutable bool isInitialized_;
154 mutable Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs_;
155 mutable Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs_;
156 mutable Thyra::ModelEvaluatorBase::InArgs<Scalar> nominalValues_;
157 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > x_space_;
158 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > f_space_;
159 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > p_space_;
160 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > g_space_;
161 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > DxDp_space_;
162
163 // Parameters for the model: x_0(t) = a + b*sin(f*t+phi)
164 // x_1(t) = b*f*cos(f*t+phi)
165 Scalar a_;
166 Scalar f_;
167 Scalar L_;
168 Scalar phi_;
169 Scalar b_;
170 Scalar t0_ic_;
171 Scalar x0_ic_;
172 Scalar x1_ic_;
173};
174
175
177//Teuchos::RCP<SinCosModel> sineCosineModel(
178// Teuchos::RCP<Teuchos::ParameterList> pList_)
179//{
180// Teuchos::RCP<SinCosModel> model = rcp(new SinCosModel(pList_));
181// return(model);
182//}
183
185
189template<class Scalar>
191 : public SinCosModel<Scalar>
192{
193 public:
194
195 // Constructor
196 SinCosModelAdjoint(Teuchos::RCP<Teuchos::ParameterList> pList = Teuchos::null) : SinCosModel<Scalar>(pList) {}
197
200
201 Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
202 Teuchos::RCP<Thyra::LinearOpWithSolveBase<Scalar> > create_W() const;
203 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
204
206
207private:
208
211 Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
212 void evalModelImpl(
213 const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs_bar,
214 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs_bar
215 ) const;
217};
218
219} // namespace Tempus_Test
220#endif // TEMPUS_TEST_SINCOS_MODEL_DECL_HPP
SinCosModelAdjoint(Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs_bar, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs_bar) const
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
Teuchos::RCP< Thyra::LinearOpWithSolveBase< Scalar > > create_W() const
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
Sine-Cosine model problem from Rythmos. This is a canonical Sine-Cosine differential equation.
int dim_
Number of state unknowns (2)
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
int np_
Number of parameters in this vector (2)
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > p_space_
Scalar x0_ic_
Initial condition for x0.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > g_space_
bool useDfDpAsTangent_
Treat DfDp OutArg as tangent (df/dx*dx/dp+df/dp)
int Np_
Number of parameter vectors (1)
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > DxDp_space_
Scalar t0_ic_
Time value where the initial condition is specified.
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
Thyra::ModelEvaluatorBase::InArgs< Scalar > getExactSolution(double t) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > x_space_
Scalar a_
Model parameter.
Scalar x1_ic_
Initial condition for x1.
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Teuchos::RCP< Thyra::LinearOpWithSolveBase< Scalar > > create_W() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > f_space_
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs_bar, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs_bar) const
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Scalar f_
Model parameter.
Thyra::ModelEvaluatorBase::InArgs< Scalar > getExactSensSolution(int j, double t) const
Scalar L_
Model parameter.
SinCosModel(Teuchos::RCP< Teuchos::ParameterList > pList=Teuchos::null)
Scalar b_
Parameter determined from the IC.
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
bool acceptModelParams_
Changes inArgs to require parameters.
void setParameterList(Teuchos::RCP< Teuchos::ParameterList > const &paramList)
Thyra::ModelEvaluatorBase::InArgs< Scalar > nominalValues_
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int j) const
int ng_
Number of elements in this observation function (1)
int Ng_
Number of observation functions (1)
bool haveIC_
false => no nominal values are provided (default=true)
Scalar phi_
Parameter determined from the IC.
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int l) const