#include <AlgLoop.h>
◆ ~KinsolSolver()
oms::KinsolSolver::~KinsolSolver |
( |
| ) |
|
Destroy the oms::KinsolSolver::KinsolSolver object.
◆ kinsolSolve()
Solve algebraic system with KINSOL.
- Parameters
-
syst | Reference to System object |
graph | Reference to graph opbject |
- Returns
- oms_status_enu_t Return
oms_status_ok
on success, oms_status_warning
if solving was computed, but solution is not within tolerance and oms_status_error
if an error occured.
◆ NewKinsolSolver()
oms::KinsolSolver * oms::KinsolSolver::NewKinsolSolver |
( |
const int |
algLoopNum, |
|
|
const unsigned int |
size, |
|
|
double |
absoluteTolerance |
|
) |
| |
|
static |
Create new oms::KinsolSolver::KinsolSolver object.
- Parameters
-
algLoopNum | Number of algebraic loop |
size | Dimension of algebraic loop |
absoluteTolerance | Tolerance used for solving the loop |
- Returns
- oms::KinsolSolver* Retruns pointer to KinsolSolver object
◆ nlsKinsolResiduals()
int oms::KinsolSolver::nlsKinsolResiduals |
( |
N_Vector |
uu, |
|
|
N_Vector |
fval, |
|
|
void * |
userData |
|
) |
| |
|
staticprivate |
Residual function for KINSOL.
- Parameters
-
uu | Input value |
fval | Contains residual at output |
userData | Pointer to user data to access System, AlgLoop, Directed Graph and CSS as well as getReal and setReal |
- Returns
- int Return 0 on success, 1 if an recoverable error occured, -1 if a fatal error occured.
◆ sundialsErrorHandlerFunction()
void oms::KinsolSolver::sundialsErrorHandlerFunction |
( |
int |
errorCode, |
|
|
const char * |
module, |
|
|
const char * |
function, |
|
|
char * |
msg, |
|
|
void * |
userData |
|
) |
| |
|
staticprivate |
Error handler function given to KINSOL.
- Parameters
-
errorCode | Error code from KINSOL |
module | Name of the module reporting the error. |
function | Name of the function in which the error occurred. |
msg | Error Message. |
userData | Pointer to user data. Unused. |
◆ sundialsInfoHandlerFunction()
void oms::KinsolSolver::sundialsInfoHandlerFunction |
( |
const char * |
module, |
|
|
const char * |
function, |
|
|
char * |
msg, |
|
|
void * |
userData |
|
) |
| |
|
staticprivate |
Info handler function given to KINSOL.
Will only print information when debug loging is active.
- Parameters
-
module | Name of the module reporting the information. |
function | Name of the function reporting the information. |
msg | Message. |
userData | Pointer to user data. Unused. |
◆ fnormtol
double oms::KinsolSolver::fnormtol |
|
private |
◆ fScale
N_Vector oms::KinsolSolver::fScale |
|
private |
◆ fTmp
N_Vector oms::KinsolSolver::fTmp |
|
private |
◆ initialGuess
N_Vector oms::KinsolSolver::initialGuess |
|
private |
SUNMatrix oms::KinsolSolver::J |
|
private |
◆ kinsolMemory
void* oms::KinsolSolver::kinsolMemory |
|
private |
◆ linSol
SUNLinearSolver oms::KinsolSolver::linSol |
|
private |
◆ size
int oms::KinsolSolver::size |
|
private |
◆ uScale
N_Vector oms::KinsolSolver::uScale |
|
private |
◆ userData
void* oms::KinsolSolver::userData |
|
private |
N_Vector oms::KinsolSolver::y |
|
private |
The documentation for this class was generated from the following files:
- /var/lib/jenkins/ws/OMSimulator_maintenance_v2.1/src/OMSimulatorLib/AlgLoop.h
- /var/lib/jenkins/ws/OMSimulator_maintenance_v2.1/src/OMSimulatorLib/AlgLoop.cpp