PyTrilinos::NOX::StatusTest::MaxIters Class Reference

Inheritance diagram for PyTrilinos::NOX::StatusTest::MaxIters:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::NOX::StatusTest::MaxIters:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def checkStatus
def getStatus
def getMaxIters
def getNumIters
def __init__
def checkStatus
def getStatus
def getMaxIters
def getNumIters

Public Attributes

 this


Detailed Description

Failure test based on the maximum number of nonlinear solver
iterations.

Let $k$ denote the current number of iterations (accessed via
NOX::Solver::getNumIterations) and $k_{\\max}$ denote the tolerance
set in the constructor of this status test. This test returns
NOX::StatusTest::Failed if $ k \\geq k_{\\rm max}. $ Otherwise, it
returns NOX::StatusTest::Unconverged.

If checkStatus is called with the type set to NOX::StatusTest::None,
it then the status is set to to NOX::Status::Unevaluated and returned.
(Also niters is set to -1.)

C++ includes: NOX_StatusTest_MaxIters.H 

Member Function Documentation

def PyTrilinos::NOX::StatusTest::MaxIters::__init__ (   self,
  args 
)

__init__(self, int maxIterations, NOX::Utils u = None) -> MaxIters

NOX::StatusTest::MaxIters::MaxIters(int maxIterations, const
NOX::Utils *u=NULL)

Constructor. Specify the maximum number of nonlinear solver
iterations, $k_{\\max}$ ands optinally an error stream for printing
errors. 

def PyTrilinos::NOX::StatusTest::MaxIters::__init__ (   self,
  args 
)

__init__(self, int maxIterations, NOX::Utils u = None) -> MaxIters

NOX::StatusTest::MaxIters::MaxIters(int maxIterations, const
NOX::Utils *u=NULL)

Constructor. Specify the maximum number of nonlinear solver
iterations, $k_{\\max}$ ands optinally an error stream for printing
errors. 

def PyTrilinos::NOX::StatusTest::MaxIters::checkStatus (   self,
  args 
)

checkStatus(self, Generic problem, CheckType checkType) -> StatusType

NOX::StatusTest::StatusType
NOX::StatusTest::MaxIters::checkStatus(const NOX::Solver::Generic
&problem, NOX::StatusTest::CheckType checkType)

Test the stopping criterion

The test can (and should, if possible) be skipped if checkType is
NOX::StatusType::None. If the test is skipped, then the status should
be set to NOX::StatusTest::Unevaluated. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.

def PyTrilinos::NOX::StatusTest::MaxIters::checkStatus (   self,
  args 
)

checkStatus(self, Generic problem, CheckType checkType) -> StatusType

NOX::StatusTest::StatusType
NOX::StatusTest::MaxIters::checkStatus(const NOX::Solver::Generic
&problem, NOX::StatusTest::CheckType checkType)

Test the stopping criterion

The test can (and should, if possible) be skipped if checkType is
NOX::StatusType::None. If the test is skipped, then the status should
be set to NOX::StatusTest::Unevaluated. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.

def PyTrilinos::NOX::StatusTest::MaxIters::getMaxIters (   self,
  args 
)

getMaxIters(self) -> int

int
NOX::StatusTest::MaxIters::getMaxIters() const

Returns the Maximum number of iterations set in the constructor. 

def PyTrilinos::NOX::StatusTest::MaxIters::getMaxIters (   self,
  args 
)

getMaxIters(self) -> int

int
NOX::StatusTest::MaxIters::getMaxIters() const

Returns the Maximum number of iterations set in the constructor. 

def PyTrilinos::NOX::StatusTest::MaxIters::getNumIters (   self,
  args 
)

getNumIters(self) -> int

int
NOX::StatusTest::MaxIters::getNumIters() const

Returns the current number of iterations taken by the solver.

Returns -1 if the status of this test is NOX::StatusTest::Unevaluated.

def PyTrilinos::NOX::StatusTest::MaxIters::getNumIters (   self,
  args 
)

getNumIters(self) -> int

int
NOX::StatusTest::MaxIters::getNumIters() const

Returns the current number of iterations taken by the solver.

Returns -1 if the status of this test is NOX::StatusTest::Unevaluated.

def PyTrilinos::NOX::StatusTest::MaxIters::getStatus (   self,
  args 
)

getStatus(self) -> StatusType

NOX::StatusTest::StatusType NOX::StatusTest::MaxIters::getStatus()
const

Return the result of the most recent checkStatus call. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.

def PyTrilinos::NOX::StatusTest::MaxIters::getStatus (   self,
  args 
)

getStatus(self) -> StatusType

NOX::StatusTest::StatusType NOX::StatusTest::MaxIters::getStatus()
const

Return the result of the most recent checkStatus call. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.


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

Generated on Thu Dec 17 11:00:22 2009 for PyTrilinos by  doxygen 1.5.9