EpetraExt::ModelEvaluator Class Reference

Base interface for evaluating a stateless "model". More...

#include <EpetraExt_ModelEvaluator.h>

Inheritance diagram for EpetraExt::ModelEvaluator:

[legend]
List of all members.

Public types

enum  EInArgsMembers {
  IN_ARG_x_dot, IN_ARG_x, IN_ARG_x_dot_poly, IN_ARG_x_poly,
  IN_ARG_t, IN_ARG_alpha, IN_ARG_beta
}
 . More...
enum  EEvalType { EVAL_TYPE_EXACT, EVAL_TYPE_APPROX_DERIV, EVAL_TYPE_VERY_APPROX_DERIV }
 . More...
enum  EDerivativeMultiVectorOrientation { DERIV_MV_BY_COL, DERIV_TRANS_MV_BY_ROW }
  More...
enum  EDerivativeLinearOp { DERIV_LINEAR_OP }
  More...
enum  EDerivativeLinearity { DERIV_LINEARITY_UNKNOWN, DERIV_LINEARITY_CONST, DERIV_LINEARITY_NONCONST }
  More...
enum  ERankStatus { DERIV_RANK_UNKNOWN, DERIV_RANK_FULL, DERIV_RANK_DEFICIENT }
  More...
enum  EOutArgsMembers { OUT_ARG_f, OUT_ARG_W, OUT_ARG_f_poly }
 . More...
enum  EOutArgsDfDp { OUT_ARG_DfDp }
  More...
enum  EOutArgsDgDx { OUT_ARG_DgDx }
  More...
enum  EOutArgsDgDp { OUT_ARG_DgDp }
  More...
const int NUM_E_IN_ARGS_MEMBERS = 7
const int NUM_E_OUT_ARGS_MEMBERS = 3

Destructor

virtual ~ModelEvaluator ()
 

Vector maps

virtual Teuchos::RefCountPtr<
const Epetra_Map
get_x_map () const =0
 .
virtual Teuchos::RefCountPtr<
const Epetra_Map
get_f_map () const =0
 .
virtual Teuchos::RefCountPtr<
const Epetra_Map
get_p_map (int l) const
 .
virtual Teuchos::RefCountPtr<
const Epetra_Map
get_g_map (int j) const
 .

Initial guesses for variables/parameters

virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_x_init () const
 
virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_x_dot_init () const
 
virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_p_init (int l) const
 
virtual double get_t_init () const
 

Bounds for variables/parameters

virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_x_lower_bounds () const
 
virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_x_upper_bounds () const
 
virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_p_lower_bounds (int l) const
 
virtual Teuchos::RefCountPtr<
const Epetra_Vector
get_p_upper_bounds (int l) const
 
virtual double get_t_lower_bound () const
 
virtual double get_t_upper_bound () const
 

Factory functions for creating derivative objects

virtual Teuchos::RefCountPtr<
Epetra_Operator
create_W () const
 If supported, create a Epetra_Operator object for W to be evaluated.
virtual Teuchos::RefCountPtr<
Epetra_Operator
create_DfDp_op (int l) const
 
virtual Teuchos::RefCountPtr<
Epetra_Operator
create_DgDx_op (int j) const
 
virtual Teuchos::RefCountPtr<
Epetra_Operator
create_DgDp_op (int j, int l) const
 

Computational functions

virtual InArgs createInArgs () const =0
 
virtual OutArgs createOutArgs () const =0
 
virtual void evalModel (const InArgs &inArgs, const OutArgs &outArgs) const =0
 

Detailed Description

Base interface for evaluating a stateless "model".

ToDo: Finish Documentation!

Definition at line 48 of file EpetraExt_ModelEvaluator.h.


Member Enumeration Documentation

enum EpetraExt::ModelEvaluator::EInArgsMembers
 

.

Enumeration values:
IN_ARG_x_dot 
IN_ARG_x 
IN_ARG_x_dot_poly 
IN_ARG_x_poly 
IN_ARG_t 
IN_ARG_alpha 
IN_ARG_beta 

Definition at line 55 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EEvalType
 

.

Enumeration values:
EVAL_TYPE_EXACT  Exact function evaluation.
EVAL_TYPE_APPROX_DERIV  An approximate derivative (i.e. for a Jacobian).
EVAL_TYPE_VERY_APPROX_DERIV  A very approximate derivative (i.e. for a preconditioner).

Definition at line 135 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EDerivativeMultiVectorOrientation
 

Enumeration values:
DERIV_MV_BY_COL 
DERIV_TRANS_MV_BY_ROW 

Definition at line 163 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EDerivativeLinearOp
 

Enumeration values:
DERIV_LINEAR_OP 

Definition at line 169 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EDerivativeLinearity
 

Enumeration values:
DERIV_LINEARITY_UNKNOWN 
DERIV_LINEARITY_CONST 
DERIV_LINEARITY_NONCONST 

Definition at line 235 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::ERankStatus
 

Enumeration values:
DERIV_RANK_UNKNOWN 
DERIV_RANK_FULL 
DERIV_RANK_DEFICIENT 

Definition at line 241 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EOutArgsMembers
 

.

Enumeration values:
OUT_ARG_f 
OUT_ARG_W 
OUT_ARG_f_poly 

Definition at line 318 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EOutArgsDfDp
 

Enumeration values:
OUT_ARG_DfDp 

Definition at line 326 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EOutArgsDgDx
 

Enumeration values:
OUT_ARG_DgDx 

Definition at line 331 of file EpetraExt_ModelEvaluator.h.

enum EpetraExt::ModelEvaluator::EOutArgsDgDp
 

Enumeration values:
OUT_ARG_DgDp 

Definition at line 336 of file EpetraExt_ModelEvaluator.h.


Constructor & Destructor Documentation

EpetraExt::ModelEvaluator::~ModelEvaluator  )  [virtual]
 

Definition at line 321 of file EpetraExt_ModelEvaluator.cpp.


Member Function Documentation

virtual Teuchos::RefCountPtr<const Epetra_Map> EpetraExt::ModelEvaluator::get_x_map  )  const [pure virtual]
 

.

Implemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

virtual Teuchos::RefCountPtr<const Epetra_Map> EpetraExt::ModelEvaluator::get_f_map  )  const [pure virtual]
 

.

Implemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Teuchos::RefCountPtr< const Epetra_Map > EpetraExt::ModelEvaluator::get_p_map int  l  )  const [virtual]
 

.

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 327 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Map > EpetraExt::ModelEvaluator::get_g_map int  j  )  const [virtual]
 

.

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 331 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_x_init  )  const [virtual]
 

Reimplemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 337 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_x_dot_init  )  const [virtual]
 

Definition at line 341 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_p_init int  l  )  const [virtual]
 

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 345 of file EpetraExt_ModelEvaluator.cpp.

double EpetraExt::ModelEvaluator::get_t_init  )  const [virtual]
 

Definition at line 348 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_x_lower_bounds  )  const [virtual]
 

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 354 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_x_upper_bounds  )  const [virtual]
 

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 358 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_p_lower_bounds int  l  )  const [virtual]
 

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 362 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< const Epetra_Vector > EpetraExt::ModelEvaluator::get_p_upper_bounds int  l  )  const [virtual]
 

Reimplemented in EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 366 of file EpetraExt_ModelEvaluator.cpp.

double EpetraExt::ModelEvaluator::get_t_lower_bound  )  const [virtual]
 

Definition at line 369 of file EpetraExt_ModelEvaluator.cpp.

double EpetraExt::ModelEvaluator::get_t_upper_bound  )  const [virtual]
 

Definition at line 372 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< Epetra_Operator > EpetraExt::ModelEvaluator::create_W  )  const [virtual]
 

If supported, create a Epetra_Operator object for W to be evaluated.

The default implementation returns return.get()==NULL (i.e. implicit solvers are not supported by default).

Reimplemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

Definition at line 378 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< Epetra_Operator > EpetraExt::ModelEvaluator::create_DfDp_op int  l  )  const [virtual]
 

Reimplemented in GLpApp::AdvDiffReactOptModel.

Definition at line 382 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< Epetra_Operator > EpetraExt::ModelEvaluator::create_DgDx_op int  j  )  const [virtual]
 

Definition at line 386 of file EpetraExt_ModelEvaluator.cpp.

Teuchos::RefCountPtr< Epetra_Operator > EpetraExt::ModelEvaluator::create_DgDp_op int  j,
int  l
const [virtual]
 

Definition at line 390 of file EpetraExt_ModelEvaluator.cpp.

virtual InArgs EpetraExt::ModelEvaluator::createInArgs  )  const [pure virtual]
 

Implemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

virtual OutArgs EpetraExt::ModelEvaluator::createOutArgs  )  const [pure virtual]
 

Implemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.

virtual void EpetraExt::ModelEvaluator::evalModel const InArgs inArgs,
const OutArgs outArgs
const [pure virtual]
 

Implemented in EpetraModelEval2DSim, EpetraModelEval4DOpt, and GLpApp::AdvDiffReactOptModel.


Member Data Documentation

const int EpetraExt::ModelEvaluator::NUM_E_IN_ARGS_MEMBERS = 7 [static]
 

Definition at line 64 of file EpetraExt_ModelEvaluator.h.

const int EpetraExt::ModelEvaluator::NUM_E_OUT_ARGS_MEMBERS = 3 [static]
 

Definition at line 323 of file EpetraExt_ModelEvaluator.h.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:31:47 2008 for EpetraExt by doxygen 1.3.9.1