PyTrilinos.NOX.Epetra.ModelEvaluatorInterface Class Reference

Inheritance diagram for PyTrilinos.NOX.Epetra.ModelEvaluatorInterface:

Collaboration diagram for PyTrilinos.NOX.Epetra.ModelEvaluatorInterface:

List of all members.

Public Member Functions
def	computeF
def	computeJacobian
def	computePreconditioner
def	inargs_set_p
def	set_inargs
def	__init__
Public Attributes
	this

---

Detailed Description

Proxy of C++ NOX::Epetra::ModelEvaluatorInterface class

---

Constructor & Destructor Documentation

def PyTrilinos.NOX.Epetra.ModelEvaluatorInterface.__init__	(		self,
			args
	)

__init__(NOX::Epetra::ModelEvaluatorInterface self, ModelEvaluator eeme) -> ModelEvaluatorInterface

Reimplemented from PyTrilinos.NOX.Epetra.Interface.Required.

---

Member Function Documentation

def PyTrilinos.NOX.Epetra.ModelEvaluatorInterface.computeF	(		self,
			args
	)

computeF(self, Epetra.Vector x, Epetra.Vector F, FillType flag) -> bool

  Virtual method in C++ that is intended to be overridden by user.
  This method defines the nonlinear function to be solved.  Arguments
  x and F will be provided as numpy-hybrid Epetra.Vector objects.
  Return True if the computation is successful.

  It is strongly recommended that computeF() not raise any exceptions,
  accidental or otherwise.  This can be prevented by wrapping your
  algorithm in a try block:

    try:
      # Your code here...
    except Exception, e:
      print 'Python exception raised in computeF():'
      print e
      return False

  By returning False, you tell NOX that computeF() was unsuccessful.


virtual bool NOX::Epetra::Interface::Required::computeF(const
Epetra_Vector &x, Epetra_Vector &F, const FillType fillFlag)=0

Compute the function, F, given the specified input vector x. Returns
true if computation was successful. 

Reimplemented from PyTrilinos.NOX.Epetra.Interface.Required.

def PyTrilinos.NOX.Epetra.ModelEvaluatorInterface.computeJacobian	(		self,
			args
	)

computeJacobian(ModelEvaluatorInterface self, Epetra_Vector x, Operator Jac) -> bool

virtual bool
NOX::Epetra::Interface::Jacobian::computeJacobian(const Epetra_Vector
&x, Epetra_Operator &Jac)=0

Compute Jacobian given the specified input vector x. Returns true if
computation was successful. 

Reimplemented from PyTrilinos.NOX.Epetra.Interface.Jacobian.

def PyTrilinos.NOX.Epetra.ModelEvaluatorInterface.computePreconditioner	(		self,
			args
	)

computePreconditioner(ModelEvaluatorInterface self, Epetra_Vector x, Operator M, ParameterList precParams=None) -> bool

virtual bool
NOX::Epetra::Interface::Preconditioner::computePreconditioner(const
Epetra_Vector &x, Epetra_Operator &M, Teuchos::ParameterList
*precParams=0)=0

Computes a user defined preconditioner. 

Reimplemented from PyTrilinos.NOX.Epetra.Interface.Preconditioner.

def PyTrilinos.NOX.Epetra.ModelEvaluatorInterface.inargs_set_p	(		self,
			args
	)

inargs_set_p(ModelEvaluatorInterface self, Teuchos::RCP< Epetra_Vector const > const p, int const l=0) -> bool

def PyTrilinos.NOX.Epetra.ModelEvaluatorInterface.set_inargs	(		self,
			args
	)

set_inargs(ModelEvaluatorInterface self, EpetraExt::ModelEvaluator::InArgs const & inargs_in) -> bool

---

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

• NOX/Epetra/__init__.py