Thyra::EpetraModelEvaluator Class Reference

#include <Thyra_EpetraModelEvaluator.hpp>

Inheritance diagram for Thyra::EpetraModelEvaluator:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors/utilities.

 EpetraModelEvaluator ()
 
 EpetraModelEvaluator (const Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > &epetraModel, const Teuchos::RefCountPtr< LinearOpWithSolveFactoryBase< double > > &W_factory)
 
void initialize (const Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > &epetraModel, const Teuchos::RefCountPtr< LinearOpWithSolveFactoryBase< double > > &W_factory)
 
Teuchos::RefCountPtr< const
EpetraExt::ModelEvaluator
getEpetraModel () const
 
void setNominalValues (const ModelEvaluatorBase::InArgs< double > &nominalValues)
 Set the nominal values.
void setStateVariableScalingVec (const Teuchos::RefCountPtr< const Epetra_Vector > &stateVariableScalingVec)
 Set the state variable scaling vector s_x (see above).
Teuchos::RefCountPtr< const
Epetra_Vector > 
getStateVariableScalingVec () const
 Get the state variable scaling vector s_x (see above).
void setStateFunctionScalingVec (const Teuchos::RefCountPtr< const Epetra_Vector > &stateFunctionScalingVec)
 Set the state function scaling vector s_f (see above).
Teuchos::RefCountPtr< const
Epetra_Vector > 
getStateFunctionScalingVec () const
 Get the state function scaling vector s_f (see above).
void uninitialize (Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > *epetraModel=NULL, Teuchos::RefCountPtr< LinearOpWithSolveFactoryBase< double > > *W_factory=NULL)
 
const ModelEvaluatorBase::InArgs<
double > & 
getFinalPoint () const
 
bool finalPointWasSolved () const
 

Overridden from ParameterListAcceptor

void setParameterList (Teuchos::RefCountPtr< Teuchos::ParameterList > const &paramList)
 
Teuchos::RefCountPtr< Teuchos::ParameterListgetParameterList ()
 
Teuchos::RefCountPtr< Teuchos::ParameterListunsetParameterList ()
 
Teuchos::RefCountPtr< const
Teuchos::ParameterList
getParameterList () const
 
Teuchos::RefCountPtr< const
Teuchos::ParameterList
getValidParameters () const
 

Public functions overridden from ModelEvaulator.

int Np () const
 
int Ng () const
 
Teuchos::RefCountPtr< const
VectorSpaceBase< double > > 
get_x_space () const
 
Teuchos::RefCountPtr< const
VectorSpaceBase< double > > 
get_f_space () const
 
Teuchos::RefCountPtr< const
VectorSpaceBase< double > > 
get_p_space (int l) const
 
Teuchos::RefCountPtr< const
VectorSpaceBase< double > > 
get_g_space (int j) const
 
ModelEvaluatorBase::InArgs<
double > 
getNominalValues () const
 
ModelEvaluatorBase::InArgs<
double > 
getLowerBounds () const
 
ModelEvaluatorBase::InArgs<
double > 
getUpperBounds () const
 
Teuchos::RefCountPtr< LinearOpWithSolveBase<
double > > 
create_W () const
 
Teuchos::RefCountPtr< LinearOpBase<
double > > 
create_W_op () const
 
Teuchos::RefCountPtr< LinearOpBase<
double > > 
create_DfDp_op (int l) const
 
Teuchos::RefCountPtr< LinearOpBase<
double > > 
create_DgDx_op (int j) const
 
Teuchos::RefCountPtr< LinearOpBase<
double > > 
create_DgDp_op (int j, int l) const
 
ModelEvaluatorBase::InArgs<
double > 
createInArgs () const
 
ModelEvaluatorBase::OutArgs<
double > 
createOutArgs () const
 
void evalModel (const ModelEvaluatorBase::InArgs< double > &inArgs, const ModelEvaluatorBase::OutArgs< double > &outArgs) const
 
void reportFinalPoint (const ModelEvaluatorBase::InArgs< double > &finalPoint, const bool wasSolved)
 

Public functions overridden from Teuchos::Describable.

std::string description () const
 

Public Types

enum  EStateFunctionScaling { STATE_FUNC_SCALING_NONE, STATE_FUNC_SCALING_ROW_SUM }

Detailed Description

Examples:

ForwardSolveEpetraModelEval2DSimMain.cpp.


Member Enumeration Documentation

enum Thyra::EpetraModelEvaluator::EStateFunctionScaling
 

Enumeration values:
STATE_FUNC_SCALING_NONE 
STATE_FUNC_SCALING_ROW_SUM 


Constructor & Destructor Documentation

Thyra::EpetraModelEvaluator::EpetraModelEvaluator  ) 
 

Thyra::EpetraModelEvaluator::EpetraModelEvaluator const Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > &  epetraModel,
const Teuchos::RefCountPtr< LinearOpWithSolveFactoryBase< double > > &  W_factory
 


Member Function Documentation

void Thyra::EpetraModelEvaluator::initialize const Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > &  epetraModel,
const Teuchos::RefCountPtr< LinearOpWithSolveFactoryBase< double > > &  W_factory
 

Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > Thyra::EpetraModelEvaluator::getEpetraModel  )  const
 

void Thyra::EpetraModelEvaluator::setNominalValues const ModelEvaluatorBase::InArgs< double > &  nominalValues  ) 
 

Set the nominal values.

Warning, if scaling is being used, these must be according to the scaled values, not the original unscaled values.

void Thyra::EpetraModelEvaluator::setStateVariableScalingVec const Teuchos::RefCountPtr< const Epetra_Vector > &  stateVariableScalingVec  ) 
 

Set the state variable scaling vector s_x (see above).

This function must be called after intialize() or the constructur in order to set the scaling vector correctly!

ToDo: Move this into an external strategy class object!

Teuchos::RefCountPtr< const Epetra_Vector > Thyra::EpetraModelEvaluator::getStateVariableScalingVec  )  const
 

Get the state variable scaling vector s_x (see above).

void Thyra::EpetraModelEvaluator::setStateFunctionScalingVec const Teuchos::RefCountPtr< const Epetra_Vector > &  stateFunctionScalingVec  ) 
 

Set the state function scaling vector s_f (see above).

Teuchos::RefCountPtr< const Epetra_Vector > Thyra::EpetraModelEvaluator::getStateFunctionScalingVec  )  const
 

Get the state function scaling vector s_f (see above).

void Thyra::EpetraModelEvaluator::uninitialize Teuchos::RefCountPtr< const EpetraExt::ModelEvaluator > *  epetraModel = NULL,
Teuchos::RefCountPtr< LinearOpWithSolveFactoryBase< double > > *  W_factory = NULL
 

const ModelEvaluatorBase::InArgs< double > & Thyra::EpetraModelEvaluator::getFinalPoint  )  const
 

bool Thyra::EpetraModelEvaluator::finalPointWasSolved  )  const
 

void Thyra::EpetraModelEvaluator::setParameterList Teuchos::RefCountPtr< Teuchos::ParameterList > const &  paramList  ) 
 

Teuchos::RefCountPtr< Teuchos::ParameterList > Thyra::EpetraModelEvaluator::getParameterList  )  [virtual]
 

Implements Teuchos::ParameterListAcceptor.

Teuchos::RefCountPtr< Teuchos::ParameterList > Thyra::EpetraModelEvaluator::unsetParameterList  )  [virtual]
 

Implements Teuchos::ParameterListAcceptor.

Teuchos::RefCountPtr< const Teuchos::ParameterList > Thyra::EpetraModelEvaluator::getParameterList  )  const [virtual]
 

Reimplemented from Teuchos::ParameterListAcceptor.

Teuchos::RefCountPtr< const Teuchos::ParameterList > Thyra::EpetraModelEvaluator::getValidParameters  )  const [virtual]
 

Reimplemented from Teuchos::ParameterListAcceptor.

int Thyra::EpetraModelEvaluator::Np  )  const
 

int Thyra::EpetraModelEvaluator::Ng  )  const
 

Teuchos::RefCountPtr< const VectorSpaceBase< double > > Thyra::EpetraModelEvaluator::get_x_space  )  const
 

Teuchos::RefCountPtr< const VectorSpaceBase< double > > Thyra::EpetraModelEvaluator::get_f_space  )  const
 

Teuchos::RefCountPtr< const VectorSpaceBase< double > > Thyra::EpetraModelEvaluator::get_p_space int  l  )  const
 

Teuchos::RefCountPtr< const VectorSpaceBase< double > > Thyra::EpetraModelEvaluator::get_g_space int  j  )  const
 

ModelEvaluatorBase::InArgs< double > Thyra::EpetraModelEvaluator::getNominalValues  )  const
 

ModelEvaluatorBase::InArgs< double > Thyra::EpetraModelEvaluator::getLowerBounds  )  const
 

ModelEvaluatorBase::InArgs< double > Thyra::EpetraModelEvaluator::getUpperBounds  )  const
 

Teuchos::RefCountPtr< LinearOpWithSolveBase< double > > Thyra::EpetraModelEvaluator::create_W  )  const
 

Teuchos::RefCountPtr< LinearOpBase< double > > Thyra::EpetraModelEvaluator::create_W_op  )  const
 

Teuchos::RefCountPtr< LinearOpBase< double > > Thyra::EpetraModelEvaluator::create_DfDp_op int  l  )  const
 

Teuchos::RefCountPtr< LinearOpBase< double > > Thyra::EpetraModelEvaluator::create_DgDx_op int  j  )  const
 

Teuchos::RefCountPtr< LinearOpBase< double > > Thyra::EpetraModelEvaluator::create_DgDp_op int  j,
int  l
const
 

ModelEvaluatorBase::InArgs< double > Thyra::EpetraModelEvaluator::createInArgs  )  const
 

ModelEvaluatorBase::OutArgs< double > Thyra::EpetraModelEvaluator::createOutArgs  )  const
 

void Thyra::EpetraModelEvaluator::evalModel const ModelEvaluatorBase::InArgs< double > &  inArgs,
const ModelEvaluatorBase::OutArgs< double > &  outArgs
const
 

void Thyra::EpetraModelEvaluator::reportFinalPoint const ModelEvaluatorBase::InArgs< double > &  finalPoint,
const bool  wasSolved
 

std::string Thyra::EpetraModelEvaluator::description  )  const
 


The documentation for this class was generated from the following files:
Generated on Sun May 20 12:52:58 2007 for EpetraExt/Thyra Adapters by doxygen 1.3.9.1