#include <CapeSolver.hpp>
Public Member Functions | |
| virtual SolveReturn | Solve ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder, Common::Error::ECapeSolvingError, Common::Error::ECapeOutOfResources) |
| virtual Common::Types::CapeArrayDouble | GetSolution ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) |
| virtual void | Destroy ()=0 throw (Common::Error::ECapeUnknown) |
Friends | |
| std::ostream & | operator<< (std::ostream &out_file, const ICapeNumericSolver &solver) |
Detailed Description
PMC primary object class. This interface provides facilities that are common to the different kinds of solvers, and exists to provide facilities for identifying the various algorithmic parameters (e.g. convergence accuracy, integration error tolerances etc.) that are recognised by a numerical solver, and for altering their values if necessary.
Member Function Documentation
| virtual void Destroy | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Deletes the Solver Component and all the objects associated to this particular Solver Component.
Implemented in IDASolver, DianaContinuation, and PARDASPKSolver.
| virtual Common::Types::CapeArrayDouble GetSolution | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual] |
Gets all the values of the variables that solve this System.
Implemented in IDASolver, DianaContinuation, and PARDASPKSolver.
| virtual SolveReturn Solve | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder, Common::Error::ECapeSolvingError, Common::Error::ECapeOutOfResources) [pure virtual] |
Attempts to solve the system of equations defined within the Model associated with this solver instance. Return will occur in different circumstances:
- The attempt succeeds.
- The solver gives up.
- An unexpected problem ("exception") arises.
If the underlying Model contains one or more STNs, the Solver may consider a switch to a different set of active states necessary to finding a solution. In this case, it may use the MoveToNextState method of one or more of the Model's STNs during the computation. The numerical values held in the model on return should be consistent with the set of states which are active on return.
Notes:The initial guesses for this solution will be the current variable values of the Model.
Implemented in DianaContinuation, IDASolver, PARDASPKSolver, SingAnalyser, and HopfPointContinuation.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | out_file, |
| const ICapeNumericSolver & | solver | ||
| ) | [friend] |
ostream output operator for the ICapeNumericSolver class.
The documentation for this class was generated from the following file:
