PyTrilinos::NOX::Solver::Generic Class Reference

Inheritance diagram for PyTrilinos::NOX::Solver::Generic:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::NOX::Solver::Generic:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def reset
def getStatus
def step
def solve
def getSolutionGroup
def getPreviousSolutionGroup
def getNumIterations
def getList
def __init__
def reset
def getStatus
def step
def solve
def getSolutionGroup
def getPreviousSolutionGroup
def getNumIterations
def getList


Detailed Description

Abstract nonlinear solver method interface.

Defines the type of access methods into the iterative nonlinear
solvers.

Instantiate or reset() the solver.

Find the solution via solve() or perform a single iterations via
iterate().

Get information about the current solver state via getSolutionGroup(),
getPreviousSolutionGroup(), getNumIterations(), and getList() ---
particularily useful for NOX::StatusTest methods.

Get the current status of the solver via getStatus().

C++ includes: NOX_Solver_Generic.H 

Member Function Documentation

def PyTrilinos::NOX::Solver::Generic::getList (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getList (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getNumIterations (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getNumIterations (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getPreviousSolutionGroup (   self,
  args 
)

getPreviousSolutionGroup(self) -> Group

virtual const NOX::Abstract::Group&
NOX::Solver::Generic::getPreviousSolutionGroup() const =0

Return a reference to the previous solution group. 

Reimplemented in PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, PyTrilinos::NOX::Solver::TensorBased, PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, and PyTrilinos::NOX::Solver::TensorBased.

def PyTrilinos::NOX::Solver::Generic::getPreviousSolutionGroup (   self,
  args 
)

getPreviousSolutionGroup(self) -> Group

virtual const NOX::Abstract::Group&
NOX::Solver::Generic::getPreviousSolutionGroup() const =0

Return a reference to the previous solution group. 

Reimplemented in PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, PyTrilinos::NOX::Solver::TensorBased, PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, and PyTrilinos::NOX::Solver::TensorBased.

def PyTrilinos::NOX::Solver::Generic::getSolutionGroup (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getSolutionGroup (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getStatus (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::getStatus (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::reset (   self,
  args 
)

reset(self, Vector initial_guess)
reset(self, Vector initial_guess, Teuchos::RCP<(NOX::StatusTest::Generic)> test)

virtual void
NOX::Solver::Generic::reset(const NOX::Abstract::Vector
&initial_guess, const Teuchos::RCP< NOX::StatusTest::Generic >
&test)=0

Resets the solver, sets a new status test, and sets a new initial
guess. 

Reimplemented in PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, PyTrilinos::NOX::Solver::TensorBased, PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, and PyTrilinos::NOX::Solver::TensorBased.

def PyTrilinos::NOX::Solver::Generic::reset (   self,
  args 
)

reset(self, Vector initial_guess)
reset(self, Vector initial_guess, Teuchos::RCP<(NOX::StatusTest::Generic)> test)

virtual void
NOX::Solver::Generic::reset(const NOX::Abstract::Vector
&initial_guess, const Teuchos::RCP< NOX::StatusTest::Generic >
&test)=0

Resets the solver, sets a new status test, and sets a new initial
guess. 

Reimplemented in PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, PyTrilinos::NOX::Solver::TensorBased, PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, and PyTrilinos::NOX::Solver::TensorBased.

def PyTrilinos::NOX::Solver::Generic::solve (   self,
  args 
)

solve(self) -> StatusType

virtual
NOX::StatusTest::StatusType NOX::Solver::Generic::solve()=0

Solve the nonlinear problem and return final status.

By "solve", we call iterate() until the NOX::StatusTest value is
either NOX::StatusTest::Converged or NOX::StatusTest::Failed. 

Reimplemented in PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, PyTrilinos::NOX::Solver::TensorBased, PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, and PyTrilinos::NOX::Solver::TensorBased.

def PyTrilinos::NOX::Solver::Generic::solve (   self,
  args 
)

solve(self) -> StatusType

virtual
NOX::StatusTest::StatusType NOX::Solver::Generic::solve()=0

Solve the nonlinear problem and return final status.

By "solve", we call iterate() until the NOX::StatusTest value is
either NOX::StatusTest::Converged or NOX::StatusTest::Failed. 

Reimplemented in PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, PyTrilinos::NOX::Solver::TensorBased, PyTrilinos::NOX::Solver::LineSearchBased, PyTrilinos::NOX::Solver::TrustRegionBased, PyTrilinos::NOX::Solver::InexactTrustRegionBased, and PyTrilinos::NOX::Solver::TensorBased.

def PyTrilinos::NOX::Solver::Generic::step (   self,
  args 
)

def PyTrilinos::NOX::Solver::Generic::step (   self,
  args 
)


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