OMCompiler/SimulationRuntime/cpp/Core/Solver/INonLinearAlgLoopSolver.h
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /* | ||
| 2 | * This file belongs to the OpenModelica Run-Time System | ||
| 3 | * | ||
| 4 | * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC), c/o Linköpings | ||
| 5 | * universitet, Department of Computer and Information Science, SE-58183 Linköping, Sweden. All rights | ||
| 6 | * reserved. | ||
| 7 | * | ||
| 8 | * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF THE BSD NEW LICENSE OR THE | ||
| 9 | * AGPL VERSION 3 LICENSE OR THE OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8. ANY | ||
| 10 | * USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S | ||
| 11 | * ACCEPTANCE OF THE BSD NEW LICENSE OR THE OSMC PUBLIC LICENSE OR THE AGPL | ||
| 12 | * VERSION 3, ACCORDING TO RECIPIENTS CHOICE. | ||
| 13 | * | ||
| 14 | * The OpenModelica software and the OSMC (Open Source Modelica Consortium) Public License | ||
| 15 | * (OSMC-PL) are obtained from OSMC, either from the above address, from the URLs: | ||
| 16 | * http://www.openmodelica.org or https://github.com/OpenModelica/ or | ||
| 17 | * http://www.ida.liu.se/projects/OpenModelica, and in the OpenModelica distribution. GNU | ||
| 18 | * AGPL version 3 is obtained from: https://www.gnu.org/licenses/licenses.html#GPL. The BSD NEW | ||
| 19 | * License is obtained from: http://www.opensource.org/licenses/BSD-3-Clause. | ||
| 20 | * | ||
| 21 | * This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 22 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY | ||
| 23 | * SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF | ||
| 24 | * OSMC-PL. | ||
| 25 | * | ||
| 26 | */ | ||
| 27 | |||
| 28 | #pragma once | ||
| 29 | /** @addtogroup coreSolver | ||
| 30 | * | ||
| 31 | * @{ | ||
| 32 | */ | ||
| 33 | class INonLinearAlgLoop; | ||
| 34 | |||
| 35 | |||
| 36 | /*****************************************************************************/ | ||
| 37 | /** | ||
| 38 | |||
| 39 | Abstract interface class for numerical methods for the (possibly iterative) | ||
| 40 | solution of algebraic loops in open modelica. | ||
| 41 | |||
| 42 | \date October, 1st, 2008 | ||
| 43 | \author | ||
| 44 | |||
| 45 | */ | ||
| 46 | |||
| 47 | |||
| 48 | 52 | class INonLinearAlgLoopSolver | |
| 49 | { | ||
| 50 | public: | ||
| 51 | /// Enumeration to denote the status of iteration | ||
| 52 | enum ITERATIONSTATUS | ||
| 53 | { | ||
| 54 | CONTINUE, | ||
| 55 | SOLVERERROR, | ||
| 56 | DONE, | ||
| 57 | }; | ||
| 58 | |||
| 59 | virtual ~INonLinearAlgLoopSolver() {}; | ||
| 60 | |||
| 61 | /// (Re-) initialize the solver | ||
| 62 | virtual void initialize() = 0; | ||
| 63 | |||
| 64 | /// Solution of a (non-)linear system of equations | ||
| 65 | virtual void solve() = 0; | ||
| 66 | //solve for a single instance call | ||
| 67 | virtual void solve(shared_ptr<INonLinearAlgLoop> algLoop,bool first_solve = false) = 0; | ||
| 68 | virtual bool* getConditionsWorkArray()=0; | ||
| 69 | virtual bool* getConditions2WorkArray()=0; | ||
| 70 | virtual double* getVariableWorkArray()=0; | ||
| 71 | |||
| 72 | /// Returns the status of iteration | ||
| 73 | virtual ITERATIONSTATUS getIterationStatus() = 0; | ||
| 74 | virtual void stepCompleted(double time) = 0; | ||
| 75 | virtual void restoreOldValues() = 0; | ||
| 76 | virtual void restoreNewValues() = 0; | ||
| 77 | }; | ||
| 78 | /** @} */ // end of coreSolver | ||
| 79 |