Tempus
Version of the Day
Time Integration
|
ModelEvaluator pair for implicit and explicit (IMEX) evaulations. More...
#include <Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp>
Public Member Functions | |
WrapperModelEvaluatorPairPartIMEX_Basic () | |
Default constructor – Still requires setting the models and running initialize. More... | |
WrapperModelEvaluatorPairPartIMEX_Basic (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &explicitModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &implicitModel, int numExplicitOnlyBlocks=0, int parameterIndex=-1) | |
Constructor. More... | |
virtual | ~WrapperModelEvaluatorPairPartIMEX_Basic () |
Destructor. More... | |
virtual void | initialize () |
Initialize after setting member data. More... | |
Overridden from Tempus::WrapperModelEvaluatorPairIMEX | |
virtual void | setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me) |
Set the underlying application ModelEvaluator. More... | |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getAppModel () const |
Get the underlying application ModelEvaluator. More... | |
virtual void | setInArgs (Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs) |
Set InArgs the wrapper ModelEvalutor. More... | |
virtual Thyra::ModelEvaluatorBase::InArgs < Scalar > | getInArgs () |
Get InArgs the wrapper ModelEvalutor. More... | |
virtual void | setOutArgs (Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs) |
Set OutArgs the wrapper ModelEvalutor. More... | |
virtual Thyra::ModelEvaluatorBase::OutArgs < Scalar > | getOutArgs () |
Get OutArgs the wrapper ModelEvalutor. More... | |
virtual void | setForSolve (Teuchos::RCP< TimeDerivative< Scalar > > timeDer, Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs, Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs, EVALUATION_TYPE=SOLVE_FOR_X) |
Set parameters for application implicit ModelEvaluator solve. More... | |
Methods that apply to both explicit and implicit terms. | |
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_x_space () const |
Get the x-solution space. More... | |
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_g_space (int i) const |
Get the g space. More... | |
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_p_space (int i) const |
Get the p space. More... | |
virtual void | setNumExplicitOnlyBlocks (int numExp) |
virtual void | setExplicitModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) |
virtual void | setImplicitModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getExplicitModel () const |
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | getImplicitModel () const |
virtual int | getNumExplicitOnlyBlocks () const |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getIMEXVector (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &full) const |
Extract IMEX vector from a full solution vector. More... | |
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > | getIMEXVector (const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &full) const |
Extract IMEX vector for reading. More... | |
virtual Teuchos::RCP < Thyra::VectorBase< Scalar > > | getExplicitOnlyVector (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &full) const |
Extract explicit-only vector from a full solution vector. More... | |
virtual Teuchos::RCP< const Thyra::VectorBase< Scalar > > | getExplicitOnlyVector (const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &full) const |
Extract explicit-only vector for reading. More... | |
virtual void | setParameterIndex (int parameterIndex=-1) |
Set the parameter index for explicit-only vector. More... | |
virtual int | getParameterIndex () const |
Get the parameter index for explicit-only vector. More... | |
virtual void | setUseImplicitModel (bool tf) |
Set parameter to switch wrapperME base functions between explicit and implicit functions. More... | |
virtual bool | getUseImplicitModel () const |
Get parameter to switch wrapperME base functions between explicit and implicit functions. More... | |
Overridden from Thyra::StateFuncModelEvaluatorBase | |
virtual Teuchos::RCP < Thyra::LinearOpBase< Scalar > > | create_W_op () const |
Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase < Scalar > > | get_W_factory () const |
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > | get_f_space () const |
virtual Thyra::ModelEvaluatorBase::InArgs < Scalar > | getNominalValues () const |
virtual Thyra::ModelEvaluatorBase::InArgs < Scalar > | createInArgs () const |
virtual Thyra::ModelEvaluatorBase::OutArgs < Scalar > | createOutArgsImpl () const |
virtual void | evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &in, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &out) const |
Vector Methods. | |
Overridden from Thyra::StateFuncModelEvaluatorBase | |
Vector Methods. |
Protected Member Functions | |
void | setup (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &explicitModel, const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &implicitModel, int numExplicitOnlyBlocks=0, int parameterIndex=-1) |
Setup ME when using default constructor – for derived classes. More... | |
Protected Attributes | |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | explicitModel_ |
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > | implicitModel_ |
Teuchos::RCP< TimeDerivative < Scalar > > | timeDer_ |
Thyra::ModelEvaluatorBase::InArgs < Scalar > | wrapperImplicitInArgs_ |
Thyra::ModelEvaluatorBase::OutArgs < Scalar > | wrapperImplicitOutArgs_ |
int | numExplicitOnlyBlocks_ |
int | parameterIndex_ |
implicit parameter index for explicit-only vector More... | |
bool | useImplicitModel_ |
if true, use implicitModel_ else explicitModel_ More... | |
ModelEvaluator pair for implicit and explicit (IMEX) evaulations.
All functions called on WrapperModelEvaluatorPairPartIMEX_Basic will call the same function on the implicit Model Evaluator. This was selected because the WrapperModelEvaluatorPairPartIMEX_Basic will be passed to the solvers which in turn make calls to solve the implicit ODE.
If the explicit version of the Model Evaluator functions are needed, one should directly call it through the explicit Model Evaluator, e.g., getExplicitModel()->get_x_space().
The one exception to this rule is for getNominalValues(), which is controlled by implicitNominalValues. During the Integrator initialization this->getNominalValues needs to return explicitModel_->getNominalValues() [implicitNominalValues=false is the default], but during the nonlinear solves this->getNominalValues needs to return implicitModel_->getNominalValues() [implicitNominalValues=true].
Definition at line 37 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >::WrapperModelEvaluatorPairPartIMEX_Basic | ( | ) |
Default constructor – Still requires setting the models and running initialize.
Definition at line 20 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >::WrapperModelEvaluatorPairPartIMEX_Basic | ( | const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | explicitModel, |
const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & | implicitModel, | ||
int | numExplicitOnlyBlocks = 0 , |
||
int | parameterIndex = -1 |
||
) |
Constructor.
Definition at line 27 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 52 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 153 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >.
Definition at line 378 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 400 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >.
Definition at line 421 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 357 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Get the g space.
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 137 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Get the p space.
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.
Definition at line 147 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 157 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Get the x-solution space.
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 127 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Get the underlying application ModelEvaluator.
Implements Tempus::WrapperModelEvaluator< Scalar >.
Definition at line 115 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 118 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Extract explicit-only vector from a full solution vector.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.
Definition at line 244 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Extract explicit-only vector for reading.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.
Definition at line 279 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Extract IMEX vector from a full solution vector.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.
Definition at line 166 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Extract IMEX vector for reading.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.
Definition at line 204 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 120 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Get InArgs the wrapper ModelEvalutor.
Implements Tempus::WrapperModelEvaluator< Scalar >.
Definition at line 69 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 367 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Definition at line 121 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Get OutArgs the wrapper ModelEvalutor.
Implements Tempus::WrapperModelEvaluator< Scalar >.
Definition at line 77 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Get the parameter index for explicit-only vector.
Definition at line 143 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Get parameter to switch wrapperME base functions between explicit and implicit functions.
Definition at line 148 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Initialize after setting member data.
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Reimplemented in Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >.
Definition at line 61 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
virtual |
Set the underlying application ModelEvaluator.
Implements Tempus::WrapperModelEvaluator< Scalar >.
Definition at line 103 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 112 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Set parameters for application implicit ModelEvaluator solve.
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 81 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Implements Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.
Definition at line 157 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Set InArgs the wrapper ModelEvalutor.
Implements Tempus::WrapperModelEvaluator< Scalar >.
Definition at line 65 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Definition at line 110 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
inlinevirtual |
Set OutArgs the wrapper ModelEvalutor.
Implements Tempus::WrapperModelEvaluator< Scalar >.
Definition at line 73 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
virtual |
Set the parameter index for explicit-only vector.
Definition at line 315 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
protected |
Setup ME when using default constructor – for derived classes.
Definition at line 43 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_impl.hpp.
|
inlinevirtual |
Set parameter to switch wrapperME base functions between explicit and implicit functions.
Definition at line 146 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
Definition at line 179 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
Definition at line 180 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
Definition at line 186 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
implicit parameter index for explicit-only vector
Definition at line 187 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
Definition at line 182 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
if true, use implicitModel_ else explicitModel_
Definition at line 188 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
Definition at line 183 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.
|
protected |
Definition at line 184 of file Tempus_WrapperModelEvaluatorPairPartIMEX_Basic_decl.hpp.