Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_WrapperModelEvaluatorPairPartIMEX_StaggeredFSA_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_ModelEvaluatorPairPartIMEX_StaggeredFSA_decl_hpp
10#define Tempus_ModelEvaluatorPairPartIMEX_StaggeredFSA_decl_hpp
11
12#include "Tempus_config.hpp"
14#include "Tempus_WrapperModelEvaluatorPairPartIMEX_Basic.hpp"
15#include "Tempus_StaggeredForwardSensitivityModelEvaluator.hpp"
16
17#include "Thyra_ProductMultiVectorBase.hpp"
18#include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
19#include "Thyra_DefaultMultiVectorProductVector.hpp"
20
21namespace Tempus {
22
31template <typename Scalar>
33 : public SensitivityModelEvaluatorBase<Scalar>,
35{
36public:
37
40 const Teuchos::RCP<const WrapperModelEvaluatorPairPartIMEX_Basic<Scalar> >& forwardModel,
41 const bool is_pseudotransient,
42 const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null);
43
46
48 virtual void initialize();
49
51
52
53 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
54 get_p_space(int i) const;
55
57
59
61 virtual Teuchos::RCP<Thyra::VectorBase<Scalar> >
63 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & full) const;
64
66 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> >
68 const Teuchos::RCP<const Thyra::VectorBase<Scalar> > & full) const;
69
71 virtual Teuchos::RCP<Thyra::VectorBase<Scalar> >
73 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & full) const;
74
76 virtual Teuchos::RCP<const Thyra::VectorBase<Scalar> >
78 const Teuchos::RCP<const Thyra::VectorBase<Scalar> > & full) const;
79
81
83
84
86 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
87 getForwardModel() const;
88
90 virtual void setForwardSolutionHistory(
91 const Teuchos::RCP<const Tempus::SolutionHistory<Scalar> >& sh);
92
94 virtual void setForwardSolutionState(
95 const Teuchos::RCP<const Tempus::SolutionState<Scalar> >& s);
96
98 virtual void setSolver(
99 const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
100 const bool force_W_update);
101
103
105
106
107 virtual Thyra::ModelEvaluatorBase::InArgs<Scalar>
108 createInArgs() const;
109
110 virtual void
112 const Thyra::ModelEvaluatorBase::InArgs<Scalar> & inArgs,
113 const Thyra::ModelEvaluatorBase::OutArgs<Scalar> & outArgs) const;
114
116
117 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
118
119protected:
120
122 void buildIMEXStates() const;
123
125 typedef Thyra::DefaultMultiVectorProductVectorSpace<Scalar> DMVPVS;
126 typedef Thyra::DefaultMultiVectorProductVector<Scalar> DMVPV;
127 typedef Thyra::ProductMultiVectorBase<Scalar> PMVB;
129
130 Teuchos::RCP<const WrapperModelEvaluatorPairPartIMEX_Basic<Scalar> > forwardModel_;
131 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > appExplicitModel_;
132 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > appImplicitModel_;
133 Teuchos::RCP<FSAME> fsaExplicitModel_;
134 Teuchos::RCP<FSAME> fsaImplicitModel_;
135
138
139 Teuchos::RCP<const DMVPVS> explicit_dydp_prod_space_;
140 Teuchos::RCP<const DMVPVS> imex_dxdp_prod_space_;
141
142 Teuchos::RCP<const Tempus::SolutionHistory<Scalar> > sh_;
143 mutable Scalar t_interp_;
144 mutable Teuchos::RCP<const Tempus::SolutionState<Scalar> > forward_state_;
145 mutable Teuchos::RCP<Tempus::SolutionState<Scalar> > nc_forward_state_;
146 mutable Teuchos::RCP<const Tempus::SolutionState<Scalar> > explicit_y_state_;
147 mutable Teuchos::RCP<const Tempus::SolutionState<Scalar> > implicit_x_state_;
148
149 mutable Teuchos::RCP<Thyra::MultiVectorBase<Scalar> > my_dfdp_mv_;
150 mutable Teuchos::RCP<Thyra::LinearOpBase<Scalar> > my_dfdp_op_;
151
152};
153
154} // namespace Tempus
155
156#endif // Tempus_ModelEvaluatorPairPartIMEX_Basic_decl_hpp
A ModelEvaluator decorator for sensitivity analysis.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Solution state for integrators and steppers. SolutionState contains the metadata for solutions and th...
Transform a ModelEvaluator's sensitivity equations to its residual.
ModelEvaluator pair for implicit and explicit (IMEX) evaulations.
virtual void setForwardSolutionState(const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &s)
Set solution state from forward state evaluation (for frozen state)
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getExplicitOnlyVector(const Teuchos::RCP< Thyra::VectorBase< Scalar > > &full) const
Extract explicit-only vector from a full solution vector.
Teuchos::RCP< const WrapperModelEvaluatorPairPartIMEX_Basic< Scalar > > forwardModel_
virtual void setForwardSolutionHistory(const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
Set solution history from forward state evaluation (for interpolation)
virtual void evalModelImpl(const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
virtual void setSolver(const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const bool force_W_update)
Set the solver of the underlying model if you want to reuse it.
virtual Teuchos::RCP< Thyra::VectorBase< Scalar > > getIMEXVector(const Teuchos::RCP< Thyra::VectorBase< Scalar > > &full) const
Extract IMEX vector from a full solution vector.
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getForwardModel() const
Get the underlying forward model.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int i) const
Get the p space.
void buildIMEXStates() const
Build implicit x and end explicit y states from forward_state_.