NOX::Epetra::ModelEvaluatorInterface Class Reference
Wrapper for an EpetraExt::ModelEvaluator. More...
#include <NOX_Epetra_ModelEvaluatorInterface.H>
Public Member Functions | |
| ModelEvaluatorInterface (const Teuchos::RCP< EpetraExt::ModelEvaluator > &m) | |
| Constructor. | |
| virtual | ~ModelEvaluatorInterface () |
| Destructor. | |
| virtual bool | computeF (const Epetra_Vector &x, Epetra_Vector &F, const FillType fillFlag) |
| Compute the function, F, given the specified input vector x. Returns true if computation was successful. | |
| virtual bool | computeJacobian (const Epetra_Vector &x, Epetra_Operator &Jac) |
| virtual bool | computePreconditioner (const Epetra_Vector &x, Epetra_Operator &M, Teuchos::ParameterList *precParams=0) |
| Computes a user defined preconditioner. | |
Protected Attributes | |
| Teuchos::RCP < EpetraExt::ModelEvaluator > | model_ |
| RCP to the Model Evaluator. | |
| EpetraExt::ModelEvaluator::InArgs | inargs_ |
| Inargs object. | |
| EpetraExt::ModelEvaluator::OutArgs | outargs_ |
| Outargs object. | |
| Teuchos::RCP< const Epetra_Vector > | x_ |
| RCP for the solution vector. | |
| Teuchos::RCP< Epetra_Vector > | f_ |
| RCP for the residual vector. | |
| Teuchos::RCP< Epetra_Operator > | jacobian_ |
| RCP for the Jacobian operator. | |
| EpetraExt::ModelEvaluator::Evaluation < Epetra_Vector > | eval_f_ |
| RCP for the residual vector wrapper. | |
Detailed Description
Wrapper for an EpetraExt::ModelEvaluator.If an application interfaces their code to solvers using the EpetraExt::ModelEvaluator, this class provides a wrapper so that the model evaluator can be used instead of having the user write concrete versions of the NOX::Epetra::Interface objects.
Definition at line 61 of file NOX_Epetra_ModelEvaluatorInterface.H.
Constructor & Destructor Documentation
| NOX::Epetra::ModelEvaluatorInterface::ModelEvaluatorInterface | ( | const Teuchos::RCP< EpetraExt::ModelEvaluator > & | m | ) |
| NOX::Epetra::ModelEvaluatorInterface::~ModelEvaluatorInterface | ( | ) | [virtual] |
Destructor.
Reimplemented in LOCA::Epetra::ModelEvaluatorInterface.
Definition at line 61 of file NOX_Epetra_ModelEvaluatorInterface.C.
Member Function Documentation
| bool NOX::Epetra::ModelEvaluatorInterface::computeF | ( | const Epetra_Vector & | x, | |
| Epetra_Vector & | F, | |||
| const FillType | fillFlag | |||
| ) | [virtual] |
Compute the function, F, given the specified input vector x. Returns true if computation was successful.
Implements NOX::Epetra::Interface::Required.
Reimplemented in LOCA::Epetra::ModelEvaluatorInterface.
Definition at line 69 of file NOX_Epetra_ModelEvaluatorInterface.C.
References eval_f_, f_, inargs_, NOX::Epetra::Interface::Required::Jac, jacobian_, model_, outargs_, NOX::Epetra::Interface::Required::Residual, and x_.
| bool NOX::Epetra::ModelEvaluatorInterface::computeJacobian | ( | const Epetra_Vector & | x, | |
| Epetra_Operator & | Jac | |||
| ) | [virtual] |
Compute Jacobian given the specified input vector x. Returns true if computation was successful.
Implements NOX::Epetra::Interface::Jacobian.
Reimplemented in LOCA::Epetra::ModelEvaluatorInterface.
Definition at line 96 of file NOX_Epetra_ModelEvaluatorInterface.C.
References eval_f_, f_, inargs_, jacobian_, model_, outargs_, and x_.
| bool NOX::Epetra::ModelEvaluatorInterface::computePreconditioner | ( | const Epetra_Vector & | x, | |
| Epetra_Operator & | M, | |||
| Teuchos::ParameterList * | precParams = 0 | |||
| ) | [virtual] |
Computes a user defined preconditioner.
Implements NOX::Epetra::Interface::Preconditioner.
Reimplemented in LOCA::Epetra::ModelEvaluatorInterface.
Definition at line 116 of file NOX_Epetra_ModelEvaluatorInterface.C.
References eval_f_, f_, inargs_, jacobian_, model_, outargs_, and x_.
Member Data Documentation
Teuchos::RCP<EpetraExt::ModelEvaluator> NOX::Epetra::ModelEvaluatorInterface::model_ [protected] |
RCP to the Model Evaluator.
Definition at line 86 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by LOCA::Epetra::ModelEvaluatorInterface::computeDfDp(), computeF(), LOCA::Epetra::ModelEvaluatorInterface::computeF(), computeJacobian(), LOCA::Epetra::ModelEvaluatorInterface::computeJacobian(), computePreconditioner(), LOCA::Epetra::ModelEvaluatorInterface::computePreconditioner(), LOCA::Epetra::ModelEvaluatorInterface::computeShiftedMatrix(), and ModelEvaluatorInterface().
EpetraExt::ModelEvaluator::InArgs NOX::Epetra::ModelEvaluatorInterface::inargs_ [protected] |
Inargs object.
Definition at line 89 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by computeF(), computeJacobian(), computePreconditioner(), and ModelEvaluatorInterface().
EpetraExt::ModelEvaluator::OutArgs NOX::Epetra::ModelEvaluatorInterface::outargs_ [protected] |
Outargs object.
Definition at line 92 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by computeF(), computeJacobian(), computePreconditioner(), and ModelEvaluatorInterface().
Teuchos::RCP<const Epetra_Vector> NOX::Epetra::ModelEvaluatorInterface::x_ [protected] |
RCP for the solution vector.
Definition at line 96 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by computeF(), computeJacobian(), and computePreconditioner().
Teuchos::RCP<Epetra_Vector> NOX::Epetra::ModelEvaluatorInterface::f_ [protected] |
RCP for the residual vector.
Definition at line 99 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by computeF(), computeJacobian(), and computePreconditioner().
Teuchos::RCP<Epetra_Operator> NOX::Epetra::ModelEvaluatorInterface::jacobian_ [protected] |
RCP for the Jacobian operator.
Definition at line 102 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by computeF(), computeJacobian(), and computePreconditioner().
EpetraExt::ModelEvaluator::Evaluation<Epetra_Vector> NOX::Epetra::ModelEvaluatorInterface::eval_f_ [protected] |
RCP for the residual vector wrapper.
Definition at line 105 of file NOX_Epetra_ModelEvaluatorInterface.H.
Referenced by computeF(), computeJacobian(), and computePreconditioner().
The documentation for this class was generated from the following files:
