PyTrilinos::NOX::Epetra::Interface::Required Class Reference
Inheritance diagram for PyTrilinos::NOX::Epetra::Interface::Required:
Collaboration diagram for PyTrilinos::NOX::Epetra::Interface::Required:
Public Member Functions | |
| def | __init__ |
| def | computeF |
| def | __disown__ |
| def | __init__ |
| def | computeF |
| def | __disown__ |
Public Attributes | |
| this | |
Static Public Attributes | |
| Residual = _Interface.Required_Residual | |
| Jac = _Interface.Required_Jac | |
| Prec = _Interface.Required_Prec | |
| FD_Res = _Interface.Required_FD_Res | |
| MF_Res = _Interface.Required_MF_Res | |
| MF_Jac = _Interface.Required_MF_Jac | |
| User = _Interface.Required_User | |
Detailed Description
Supplies NOX with the set nonlinear equations. This is the minimum required information to solve a nonlinear problem using the NOX::Epetra objects for the linear algebra implementation. Used by NOX::Epetra::Group to provide a link to the external code for residual fills. C++ includes: NOX_Epetra_Interface_Required.H
Member Function Documentation
| def PyTrilinos::NOX::Epetra::Interface::Required::__init__ | ( | self, | ||
| args | ||||
| ) |
__init__(self) -> Required NOX::Epetra::Interface::Required::Required() Constructor.
| def PyTrilinos::NOX::Epetra::Interface::Required::__init__ | ( | self, | ||
| args | ||||
| ) |
__init__(self) -> Required NOX::Epetra::Interface::Required::Required() Constructor.
| def PyTrilinos::NOX::Epetra::Interface::Required::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.
| def PyTrilinos::NOX::Epetra::Interface::Required::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.
The documentation for this class was generated from the following files:
- build/lib.linux-x86_64-2.5/PyTrilinos/NOX/Epetra/Interface.py
- PyTrilinos/NOX/Epetra/Interface.py
