Tempus  Version of the Day
Time Integration
Tempus_WrapStaggeredFSAModelEvaluator.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_WrapStaggeredFSAModelEvaluator_hpp
10 #define Tempus_WrapStaggeredFSAModelEvaluator_hpp
11 
12 #include "Tempus_config.hpp"
14 #include "Tempus_StaggeredForwardSensitivityModelEvaluator.hpp"
15 #include "Tempus_WrapperModelEvaluatorPairIMEX_Basic.hpp"
17 #include "Tempus_WrapperModelEvaluatorPairPartIMEX_StaggeredFSA.hpp"
18 
19 namespace Tempus {
20 
26 template <typename Scalar>
27 Teuchos::RCP< SensitivityModelEvaluatorBase<Scalar> >
29  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & model,
30  const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null)
31 {
32  using Teuchos::RCP;
33  using Teuchos::rcp_dynamic_cast;
34 
35  RCP<SensitivityModelEvaluatorBase<Scalar> > wrapped_model;
36 
37  // Test if model is an IMEX pair
38  RCP<const WrapperModelEvaluatorPairIMEX_Basic<Scalar> > modelPairIMEX =
39  rcp_dynamic_cast<const WrapperModelEvaluatorPairIMEX_Basic<Scalar> >(model);
40  RCP<const WrapperModelEvaluatorPairPartIMEX_Basic<Scalar> > modelPairPartIMEX =
41  rcp_dynamic_cast<const WrapperModelEvaluatorPairPartIMEX_Basic<Scalar> >(model);
42  if (modelPairIMEX != Teuchos::null) {
43  wrapped_model =
45  modelPairIMEX, pList));
46  }
47  else if (modelPairPartIMEX != Teuchos::null) {
48  wrapped_model =
50  modelPairPartIMEX, pList));
51  }
52  else {
53  wrapped_model =
55  model, pList));
56  }
57 
58  return wrapped_model;
59 }
60 
61 template <typename Scalar>
62 Teuchos::RCP< SensitivityModelEvaluatorBase<Scalar> >
64  const Teuchos::RCP<Thyra::ModelEvaluator<Scalar> > & model,
65  const Teuchos::RCP<const Teuchos::ParameterList>& pList = Teuchos::null)
66 {
67  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > cmodel = model;
68  return wrapStaggeredFSAModelEvaluator(cmodel, pList);
69 }
70 
71 } // namespace Tempus
72 
73 #endif
ModelEvaluator pair for implicit and explicit (IMEX) evaulations.
Teuchos::RCP< SensitivityModelEvaluatorBase< Scalar > > wrapStaggeredFSAModelEvaluator(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, const Teuchos::RCP< const Teuchos::ParameterList > &pList=Teuchos::null)
ModelEvaluator pair for implicit and explicit (IMEX) evaulations.
Transform a ModelEvaluator&#39;s sensitivity equations to its residual.