#include <CapeSolver.hpp>
Public Member Functions | |
| virtual void | SetCvgTolerance (Common::Types::CapeDouble cvgValue)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds) |
| virtual Common::Types::CapeDouble | GetCvgTolerance ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) |
| virtual void | SetMaxIterations (Common::Types::CapeLong maxIteration)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds) |
| virtual Common::Types::CapeLong | GetMaxIterations ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) |
| virtual Common::Types::CapeLong | DoNIteration (Common::Types::CapeLong nbIterations)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds, Common::Error::ECapeBadInvOrder, Common::Error::ECapeSolvingError, Common::Error::ECapeOutOfResources) |
Friends | |
| std::ostream & | operator<< (std::ostream &out_file, const ICapeNumericNLASolver &solver) |
Detailed Description
This interface provides facilities which are specific to Solvers of Non Linear Algebraic equation systems. This interface defines methods for the identification and setting of parameters that will occur in all CAPE-OPEN compliant nonlinear algebra components. A small number of such generic parameters have been identified; separate methods are defined for obtaining information on, and changing the value of each such parameter.
Member Function Documentation
Perform N iterations on the nonlinear algebra problem. The possible returns are the same as for Solve, except that in this case "OK+Failure" may merely indicate that more iterations are needed.
- Parameters:
-
nbIterations the number of iterations to be performed.
| virtual Common::Types::CapeDouble GetCvgTolerance | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual] |
Gets information on the convergence tolerance to be used in solving a nonlinear system, as well as its current value. The precise interpretation of this parameter will depend on individual implementations; the nature of the convergence criterion used by nonlinear solvers is not defined by CAPE-OPEN.
| virtual Common::Types::CapeLong GetMaxIterations | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual] |
Gets information on the maximum number of iterations to be used in solving a nonlinear system, as well as its current value. The precise interpretation of this parameter will depend on individual implementations; the nature of what constitutes an "iteration" used by nonlinear solvers is not defined by CAPE-OPEN.
| virtual void SetCvgTolerance | ( | Common::Types::CapeDouble | cvgValue | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds) [pure virtual] |
Sets the convergence tolerance to be used in solving a nonlinear system. The precise interpretation of this parameter will depend on individual implementations; the nature of the convergence criterion used by nonlinear solvers is not defined by CAPE-OPEN.
- Parameters:
-
cvgValue the convergence tolerance value.
| virtual void SetMaxIterations | ( | Common::Types::CapeLong | maxIteration | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds) [pure virtual] |
Sets the maximum number of iterations to be used in solving a nonlinear system. The precise interpretation of this parameter will depend on individual implementations; the nature of what constitutes an "iteration" used by nonlinear solvers is not defined by CAPE-OPEN.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | out_file, |
| const ICapeNumericNLASolver & | solver | ||
| ) | [friend] |
ostream output operator for the ICapeNumericNLASolver class.
The documentation for this class was generated from the following file:
