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 |
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
def PyTrilinos::NOX::Solver::Generic::getList | ( | self, | ||
args | ||||
) |
getList(self) -> ParameterList virtual const Teuchos::ParameterList& NOX::Solver::Generic::getList() const =0 Return a refernece to the solver parameters.
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::getList | ( | self, | ||
args | ||||
) |
getList(self) -> ParameterList virtual const Teuchos::ParameterList& NOX::Solver::Generic::getList() const =0 Return a refernece to the solver parameters.
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::getNumIterations | ( | self, | ||
args | ||||
) |
getNumIterations(self) -> int virtual int NOX::Solver::Generic::getNumIterations() const =0 Get number of iterations.
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::getNumIterations | ( | self, | ||
args | ||||
) |
getNumIterations(self) -> int virtual int NOX::Solver::Generic::getNumIterations() const =0 Get number of iterations.
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::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 | ||||
) |
getSolutionGroup(self) -> Group virtual const NOX::Abstract::Group& NOX::Solver::Generic::getSolutionGroup() const =0 Return a reference to the current 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 | ||||
) |
getSolutionGroup(self) -> Group virtual const NOX::Abstract::Group& NOX::Solver::Generic::getSolutionGroup() const =0 Return a reference to the current 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::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> StatusType virtual NOX::StatusTest::StatusType NOX::Solver::Generic::getStatus()=0 Check current convergence and failure status.
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::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> StatusType virtual NOX::StatusTest::StatusType NOX::Solver::Generic::getStatus()=0 Check current convergence and failure status.
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::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 | ||||
) |
step(self) -> 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::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 | ||||
) |
step(self) -> 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::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.