Tempus  Version of the Day
Time Integration
Tempus_WrapperModelEvaluatorPairIMEX_StaggeredFSA.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_StaggeredFSA_hpp
10 #define Tempus_ModelEvaluatorPairIMEX_StaggeredFSA_hpp
11 
12 #include "Tempus_config.hpp"
14 #include "Tempus_WrapperModelEvaluatorPairIMEX_Basic.hpp"
15 #include "Tempus_StaggeredForwardSensitivityModelEvaluator.hpp"
16 
17 namespace Tempus {
18 
25 template <typename Scalar>
27  : public SensitivityModelEvaluatorBase<Scalar>,
29 {
30 public:
31 
34  const Teuchos::RCP<const WrapperModelEvaluatorPairIMEX_Basic<Scalar> >& forwardModel,
35  const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null)
36  {
37  forwardModel_ = forwardModel;
38  appExplicitModel_ = forwardModel_->getExplicitModel();
39  appImplicitModel_ = forwardModel_->getImplicitModel();
40  fsaExplicitModel_ = rcp(new FSAME(appExplicitModel_, pList));
41  fsaImplicitModel_ = rcp(new FSAME(appImplicitModel_, pList));
43  }
44 
47 
49 
50 
52  virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
54  {
55  return forwardModel_;
56  }
57 
60  const Teuchos::RCP<const Tempus::SolutionHistory<Scalar> >& sh)
61  {
62  fsaExplicitModel_->setForwardSolutionHistory(sh);
63  fsaImplicitModel_->setForwardSolutionHistory(sh);
64  }
65 
68  const Teuchos::RCP<const Tempus::SolutionState<Scalar> >& s)
69  {
70  fsaExplicitModel_->setForwardSolutionState(s);
71  fsaImplicitModel_->setForwardSolutionState(s);
72  }
73 
75  virtual void setSolver(
76  const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
77  const bool force_W_update)
78  {
79  fsaImplicitModel_->setSolver(solver, force_W_update);
80  }
81 
83 
84 private:
85 
88 
89 protected:
90 
93 
94  Teuchos::RCP<const WrapperModelEvaluatorPairIMEX_Basic<Scalar> > forwardModel_;
95  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > appExplicitModel_;
96  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > appImplicitModel_;
97  Teuchos::RCP<FSAME> fsaExplicitModel_;
98  Teuchos::RCP<FSAME> fsaImplicitModel_;
99 };
100 
101 } // namespace Tempus
102 
103 #endif // Tempus_ModelEvaluatorPairIMEX_StaggeredFSA_hpp
WrapperModelEvaluatorPairIMEX_StaggeredFSA(const Teuchos::RCP< const WrapperModelEvaluatorPairIMEX_Basic< Scalar > > &forwardModel, const Teuchos::RCP< const Teuchos::ParameterList > &pList=Teuchos::null)
Constructor.
ModelEvaluator pair for implicit and explicit (IMEX) evaulations.
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.
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getForwardModel() const
Get the underlying forward model.
virtual void setForwardSolutionState(const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &s)
Set solution state from forward state evaluation (for frozen state)
virtual void setForwardSolutionHistory(const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &sh)
Set solution history from forward state evaluation (for interpolation)
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Teuchos::RCP< const WrapperModelEvaluatorPairIMEX_Basic< Scalar > > forwardModel_
Transform a ModelEvaluator&#39;s sensitivity equations to its residual.
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.
A ModelEvaluator decorator for sensitivity analysis.
Solution state for integrators and steppers. SolutionState contains the metadata for solutions and th...