PyTrilinos.NOX.Solver.Generic Class Reference

Inheritance diagram for PyTrilinos.NOX.Solver.Generic:

Collaboration diagram for PyTrilinos.NOX.Solver.Generic:

List of all members.

Public Member Functions
def	__init__
def	reset
def	getStatus
def	step
def	solve
def	getNumIterations
def	getSolutionGroup
def	getPreviousSolutionGroup
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
	)

getList(Generic self) -> Teuchos::RCP< Teuchos::ParameterList const >

virtual
Teuchos::RCP< const Teuchos::ParameterList >
NOX::Solver::Generic::getListPtr() const

Return a RCP to the solver parameters. 

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

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

getNumIterations(Generic self) -> int

virtual int NOX::Solver::Generic::getNumIterations() const =0

Get number of iterations. 

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

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

getPreviousSolutionGroup(Generic self) -> Teuchos::RCP< NOX::Abstract::Group const >

virtual
Teuchos::RCP< const NOX::Abstract::Group >
NOX::Solver::Generic::getPreviousSolutionGroupPtr() const

Return a RCP to the previous solution group. 

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

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

getSolutionGroup(Generic self) -> Teuchos::RCP< NOX::Abstract::Group const >

virtual Teuchos::RCP< const NOX::Abstract::Group >
NOX::Solver::Generic::getSolutionGroupPtr() const

Return a RCP to the solution group. 

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

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

getStatus(Generic self) -> NOX::StatusTest::StatusType

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

Check current convergence and failure status. 

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

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

reset(Generic self, Vector initial_guess)
reset(Generic self, Vector initial_guess, Teuchos::RCP< NOX::StatusTest::Generic > const & 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.TensorBased, PyTrilinos.NOX.Solver.InexactTrustRegionBased, PyTrilinos.NOX.Solver.TrustRegionBased, and PyTrilinos.NOX.Solver.LineSearchBased.

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

solve(Generic self) -> NOX::StatusTest::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.TensorBased, PyTrilinos.NOX.Solver.InexactTrustRegionBased, PyTrilinos.NOX.Solver.TrustRegionBased, and PyTrilinos.NOX.Solver.LineSearchBased.

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

step(Generic self) -> NOX::StatusTest::StatusType

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

Do one nonlinear step in the iteration sequence and return status. 

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

---

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

• Solver.py