Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | List of all members
Thyra::ImplicitAdjointModelEvaluator< Scalar > Class Template Reference

An implementation of AdjointModelEvaluatorBase that creates an implicit adjoint from the supplied model evaluator. More...

#include <Thyra_ImplicitAdjointModelEvaluator.hpp>

Inheritance diagram for Thyra::ImplicitAdjointModelEvaluator< Scalar >:
Thyra::ModelEvaluatorDelegatorBase< Scalar > Thyra::ModelEvaluatorDefaultBase< Scalar > Thyra::ModelEvaluator< class > Thyra::ModelEvaluatorBase Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

 ImplicitAdjointModelEvaluator (const RCP< const ModelEvaluator< Scalar > > &model)
 Constructor. More...
 
 ImplicitAdjointModelEvaluator (const RCP< ModelEvaluator< Scalar > > &model)
 Constructor. More...
 
virtual ~ImplicitAdjointModelEvaluator ()=default
 Destructor. More...
 
RCP< LinearOpWithSolveBase
< Scalar > > 
create_W () const
 Create adjoint solver. More...
 
RCP< LinearOpBase< Scalar > > create_W_op () const
 Create adjoint op. More...
 
RCP< PreconditionerBase< Scalar > > create_W_prec () const
 Create adjoint preconditioner. More...
 
RCP< const
LinearOpWithSolveFactoryBase
< Scalar > > 
get_W_factory () const
 Get adjoint solver factory. More...
 
- Public Member Functions inherited from Thyra::ModelEvaluator< class >
virtual int Np () const =0
 
virtual int Ng () const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_x_space () const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_f_space () const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_f_multiplier_space () const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_p_space (int l) const =0
 
virtual RCP< const
Teuchos::Array< std::string > > 
get_p_names (int l) const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_g_space (int j) const =0
 
virtual RCP< const
VectorSpaceBase< Scalar > > 
get_g_multiplier_space (int j) const =0
 
virtual Teuchos::ArrayView
< const std::string > 
get_g_names (int j) const =0
 
virtual
ModelEvaluatorBase::InArgs
< Scalar > 
getNominalValues () const =0
 
virtual
ModelEvaluatorBase::InArgs
< Scalar > 
getLowerBounds () const =0
 
virtual
ModelEvaluatorBase::InArgs
< Scalar > 
getUpperBounds () const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DfDp_op (int l) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DgDx_dot_op (int j) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DgDx_op (int j) const =0
 
virtual RCP< LinearOpBase
< Scalar > > 
create_DgDp_op (int j, int l) const =0
 
virtual
ModelEvaluatorBase::InArgs
< Scalar > 
createInArgs () const =0
 
virtual
ModelEvaluatorBase::OutArgs
< Scalar > 
createOutArgs () const =0
 
virtual void evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const =0
 
virtual void reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)=0
 
 ModelEvaluatorBase ()
 
std::string toString (ModelEvaluatorBase::EInArgsMembers)
 
std::string toString (ModelEvaluatorBase::EOutArgsMembers)
 
std::string toString (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
 
ModelEvaluatorBase::EDerivativeMultiVectorOrientation getOtherDerivativeMultiVectorOrientation (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Private Member Functions

void evalModelImpl (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
 

Additional Inherited Members

- Public Types inherited from Thyra::ModelEvaluator< class >
enum  EInArgsMembers
 
enum  EInArgs_p_mp
 
enum  EEvalType
 
enum  EDerivativeMultiVectorOrientation
 
enum  EDerivativeLinearOp
 
enum  EDerivativeLinearity
 
enum  ERankStatus
 
enum  EOutArgsMembers
 
enum  EOutArgsDfDp
 
enum  EOutArgsDgDx_dot
 
enum  EOutArgsDgDx
 
enum  EOutArgsDgDp
 
enum  EOutArgsDfDp_mp
 
enum  EOutArgs_g_mp
 
enum  EOutArgsDgDx_dot_mp
 
enum  EOutArgsDgDx_mp
 
enum  EOutArgsDgDp_mp
 
typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 
ScalarMag
 
- Static Public Attributes inherited from Thyra::ModelEvaluator< class >
static const int NUM_E_IN_ARGS_MEMBERS
 
static const int NUM_E_OUT_ARGS_MEMBERS
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

template<typename Scalar>
class Thyra::ImplicitAdjointModelEvaluator< Scalar >

An implementation of AdjointModelEvaluatorBase that creates an implicit adjoint from the supplied model evaluator.

Definition at line 25 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

Constructor & Destructor Documentation

template<typename Scalar >
Thyra::ImplicitAdjointModelEvaluator< Scalar >::ImplicitAdjointModelEvaluator ( const RCP< const ModelEvaluator< Scalar > > &  model)
inline

Constructor.

Definition at line 29 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

template<typename Scalar >
Thyra::ImplicitAdjointModelEvaluator< Scalar >::ImplicitAdjointModelEvaluator ( const RCP< ModelEvaluator< Scalar > > &  model)
inline

Constructor.

Definition at line 35 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

template<typename Scalar >
virtual Thyra::ImplicitAdjointModelEvaluator< Scalar >::~ImplicitAdjointModelEvaluator ( )
virtualdefault

Destructor.

Member Function Documentation

template<typename Scalar >
RCP<LinearOpWithSolveBase<Scalar> > Thyra::ImplicitAdjointModelEvaluator< Scalar >::create_W ( ) const
inlinevirtual

Create adjoint solver.

Implements Thyra::ModelEvaluator< class >.

Definition at line 44 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

template<typename Scalar >
RCP<LinearOpBase<Scalar> > Thyra::ImplicitAdjointModelEvaluator< Scalar >::create_W_op ( ) const
inlinevirtual

Create adjoint op.

Implements Thyra::ModelEvaluator< class >.

Definition at line 50 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

template<typename Scalar >
RCP<PreconditionerBase<Scalar> > Thyra::ImplicitAdjointModelEvaluator< Scalar >::create_W_prec ( ) const
inlinevirtual

Create adjoint preconditioner.

Implements Thyra::ModelEvaluator< class >.

Definition at line 56 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

template<typename Scalar >
RCP<const LinearOpWithSolveFactoryBase<Scalar> > Thyra::ImplicitAdjointModelEvaluator< Scalar >::get_W_factory ( ) const
inlinevirtual

Get adjoint solver factory.

Implements Thyra::ModelEvaluator< class >.

Definition at line 63 of file Thyra_ImplicitAdjointModelEvaluator.hpp.

template<typename Scalar >
void Thyra::ImplicitAdjointModelEvaluator< Scalar >::evalModelImpl ( const ModelEvaluatorBase::InArgs< Scalar > &  inArgs,
const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs 
) const
inlineprivate

Definition at line 70 of file Thyra_ImplicitAdjointModelEvaluator.hpp.


The documentation for this class was generated from the following file: