Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
VanDerPolModel_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_VANDERPOL_MODEL_DECL_HPP
10#define TEMPUS_TEST_VANDERPOL_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
110template<class Scalar>
112 : public Thyra::StateFuncModelEvaluatorBase<Scalar>,
113 public Teuchos::ParameterListAcceptorDefaultBase
114{
115 public:
116
117 // Constructor
118 VanDerPolModel(Teuchos::RCP<Teuchos::ParameterList> pList = Teuchos::null);
119
120 // Exact solution
121 Thyra::ModelEvaluatorBase::InArgs<Scalar> getExactSolution(double t) const;
122
123 // Exact sensitivity solution
124 Thyra::ModelEvaluatorBase::InArgs<Scalar> getExactSensSolution(int j, double t) const;
125
128
129 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
130 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
131 Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
132 Teuchos::RCP<Thyra::LinearOpWithSolveBase<Scalar> > create_W() const;
133 Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
134 Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const;
135 Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
136
137 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int l) const;
138 Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int l) const;
139 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(int j) const;
140
142
145 void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
146 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
148
149private:
150
151 void setupInOutArgs_() const;
152
155 Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
156 void evalModelImpl(
157 const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs_bar,
158 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs_bar
159 ) const;
161
162 int dim_;
163 int Np_;
164 int np_;
165 int Ng_;
166 int ng_;
167 bool haveIC_;
169 mutable bool isInitialized_;
170 mutable Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs_;
171 mutable Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs_;
172 mutable Thyra::ModelEvaluatorBase::InArgs<Scalar> nominalValues_;
173 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > x_space_;
174 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > f_space_;
175 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > p_space_;
176 Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > g_space_;
177
178 // Parameters for the model:
179 Scalar epsilon_;
180 Scalar t0_ic_;
181 Scalar x0_ic_;
182 Scalar x1_ic_;
183};
184
185
186} // namespace Tempus_Test
187#endif // TEMPUS_TEST_VANDERPOL_MODEL_DECL_HPP
van der Pol model problem for nonlinear electrical circuit.
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > x_space_
int Ng_
Number of observation functions (0)
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
Thyra::ModelEvaluatorBase::OutArgs< Scalar > createOutArgsImpl() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > g_space_
int dim_
Number of state unknowns (2)
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
Thyra::ModelEvaluatorBase::InArgs< Scalar > getExactSolution(double t) const
Thyra::ModelEvaluatorBase::InArgs< Scalar > getExactSensSolution(int j, double t) const
Thyra::ModelEvaluatorBase::InArgs< Scalar > getNominalValues() const
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
bool acceptModelParams_
Changes inArgs to require parameters.
Thyra::ModelEvaluatorBase::InArgs< Scalar > createInArgs() const
void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs_bar, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs_bar) const
bool haveIC_
false => no nominal values are provided (default=true)
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_f_space() const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const
Scalar x1_ic_
initial condition for x1
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int l) const
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int j) const
int ng_
Number of elements in this observation function (0)
Scalar x0_ic_
initial condition for x0
Teuchos::RCP< Thyra::LinearOpBase< Scalar > > create_W_op() const
Teuchos::RCP< Thyra::LinearOpWithSolveBase< Scalar > > create_W() const
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > get_W_factory() const
int Np_
Number of parameter vectors (1)
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > p_space_
int np_
Number of parameters in this vector (1)
void setParameterList(Teuchos::RCP< Teuchos::ParameterList > const &paramList)
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > f_space_
Thyra::ModelEvaluatorBase::InArgs< Scalar > nominalValues_
Scalar epsilon_
This is a model parameter.