Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_WrapperModelEvaluator.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_WrapperModelEvaluator_hpp
10#define Tempus_WrapperModelEvaluator_hpp
11
12#include "Tempus_config.hpp"
14#include "Thyra_StateFuncModelEvaluatorBase.hpp"
15
16namespace Tempus {
17
23};
24
25
34template <typename Scalar>
35class WrapperModelEvaluator : public Thyra::StateFuncModelEvaluatorBase<Scalar>
36{
37public:
38
40
41
42 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
43 get_x_space() const = 0;
44
46 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
47 get_g_space(int i) const = 0;
48
50 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> >
51 get_p_space(int i) const = 0;
53
55 virtual void setAppModel(
56 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > & me) = 0;
57
59 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
60 getAppModel() const = 0;
61
63 virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs) = 0;
64
66 virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> getInArgs() = 0;
67
69 virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs)=0;
70
72 virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar> getOutArgs() = 0;
73
75 virtual void setForSolve(Teuchos::RCP<TimeDerivative<Scalar> > td,
76 Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs,
77 Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs,
78 EVALUATION_TYPE evaluationType = SOLVE_FOR_X) = 0;
79};
80
81} // namespace Tempus
82
83#endif // Tempus_WrapperModelEvaluator_hpp
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
A ModelEvaluator which wraps the application ModelEvaluator.
virtual Thyra::ModelEvaluatorBase::OutArgs< Scalar > getOutArgs()=0
Get OutArgs the wrapper ModelEvalutor.
virtual void setOutArgs(Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs)=0
Set OutArgs the wrapper ModelEvalutor.
virtual void setForSolve(Teuchos::RCP< TimeDerivative< Scalar > > td, Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs, Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs, EVALUATION_TYPE evaluationType=SOLVE_FOR_X)=0
Set parameters for application implicit ModelEvaluator solve.
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > getInArgs()=0
Get InArgs the wrapper ModelEvalutor.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_p_space(int i) const =0
Get the p space.
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getAppModel() const =0
Get the underlying application ModelEvaluator.
virtual void setAppModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)=0
Set the underlying application ModelEvaluator.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_g_space(int i) const =0
Get the g space.
virtual void setInArgs(Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs)=0
Set InArgs the wrapper ModelEvalutor.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space() const =0
Get the x-solution space.
EVALUATION_TYPE
EVALUATION_TYPE indicates the evaluation to apply to the implicit ODE.
@ SOLVE_FOR_XDOT_CONST_X
Solve for xDot keeping x constant (for ICs).
@ SOLVE_FOR_X
Solve for x and determine xDot from x.
@ EVALUATE_RESIDUAL
Evaluate residual for the implicit ODE.