OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
|
Go to the documentation of this file.
32 #ifndef _OMS_ALGLOOP_H_
33 #define _OMS_ALGLOOP_H_
37 #include "OMSimulator/Types.h"
40 #include <kinsol/kinsol.h>
41 #include <nvector/nvector_serial.h>
42 #include <sunlinsol/sunlinsol_dense.h>
84 static int nlsKinsolJac(N_Vector u, N_Vector fu, SUNMatrix
J,
void *
user_data, N_Vector tmp1, N_Vector tmp2);
93 AlgLoop(oms_alg_solver_enu_t method,
double absTol,
scc_t SCC,
const int systNumber,
const bool useDirectionalDerivative);
DirectedGraph * graph
Definition: AlgLoop.h:51
static void sundialsInfoHandlerFunction(const char *module, const char *function, char *msg, void *user_data)
Info handler function given to KINSOL.
Definition: AlgLoop.cpp:98
struct oms::KINSOL_USER_DATA KINSOL_USER_DATA
ComRef front() const
returns the first part of the ComRef (including suffix if its the only part)
Definition: ComRef.cpp:166
static void sundialsErrorHandlerFunction(int error_code, const char *module, const char *function, char *msg, void *user_data)
Error handler function given to KINSOL.
Definition: AlgLoop.cpp:69
Strong connected components data type.
Definition: DirectedGraph.h:53
AlgLoop(oms_alg_solver_enu_t method, double absTol, scc_t SCC, const int systNumber, const bool useDirectionalDerivative)
Construct a new oms::AlgLoop::AlgLoop object.
Definition: AlgLoop.cpp:470
ComRef - component reference.
Definition: ComRef.h:46
System * syst
Definition: AlgLoop.h:50
oms_alg_solver_enu_t algSolverMethod
Definition: AlgLoop.h:101
static bool DumpAlgLoops()
Definition: Flags.h:66
static int nlsKinsolJac(N_Vector u, N_Vector fu, SUNMatrix J, void *user_data, N_Vector tmp1, N_Vector tmp2)
Jacobian function for KINSOL.
Definition: AlgLoop.cpp:132
N_Vector initialGuess
Definition: AlgLoop.h:68
oms_status_enu_t getDirectionalDerivative(const ComRef &unknownCref, const ComRef &knownCref, double &value)
Definition: System.cpp:2369
oms_status_enu_t fixPointIteration(System &syst, DirectedGraph &graph)
Fixed-point-iteration to solve algebraic loop.
Definition: AlgLoop.cpp:528
oms_status_enu_t setReal(const ComRef &cref, double value)
Definition: System.cpp:2554
AlgLoop * getAlgLoop(const int systemNumber)
Definition: System.cpp:3038
static unsigned int MaxLoopIteration()
Definition: Flags.h:91
#define logInfo(msg)
Definition: Logging.h:100
~KinsolSolver()
Destroy the oms::KinsolSolver::KinsolSolver object.
Definition: AlgLoop.cpp:271
unsigned int iteration
Definition: AlgLoop.h:53
Definition: DirectedGraph.h:64
N_Vector uScale
Definition: AlgLoop.h:69
oms_status_enu_t kinsolSolve(System &syst, DirectedGraph &graph)
Solve algebraic system with KINSOL.
Definition: AlgLoop.cpp:403
static KinsolSolver * NewKinsolSolver(const int algLoopNum, const unsigned int size, double absoluteTolerance, const bool useDirectionalDerivative)
Create new oms::KinsolSolver::KinsolSolver object.
Definition: AlgLoop.cpp:295
#define logDebug(msg)
Definition: Logging.h:109
oms_status_enu_t getReal(const ComRef &cref, double &value)
Definition: System.cpp:2241
std::string getAlgSolverName()
Return solver method.
Definition: AlgLoop.cpp:619
double fnormtol
Definition: AlgLoop.h:65
SUNLinearSolver linSol
Definition: AlgLoop.h:79
static bool DirectionalDerivatives()
Definition: Flags.h:65
#define logWarning(msg)
Definition: Logging.h:101
N_Vector y
Definition: AlgLoop.h:80
void * kinsolMemory
Definition: AlgLoop.h:74
void * user_data
Definition: AlgLoop.h:75
bool checkFlag(int flag, std::string functionName)
Check flag returned by KINSOL function and log error.
Definition: AlgLoop.cpp:49
KinsolSolver * kinsolData
Definition: AlgLoop.h:104
static bool DebugEnabled()
Definition: Logging.cpp:187
oms_status_enu_t solveAlgLoop(System &syst, DirectedGraph &graph)
Solve algebraic loop.
Definition: AlgLoop.cpp:504
double getTime() const
Definition: System.h:147
N_Vector fTmp
Definition: AlgLoop.h:71
N_Vector fScale
Definition: AlgLoop.h:70
const int algLoopNumber
Definition: AlgLoop.h:52
scc_t getSCC()
Definition: AlgLoop.h:95
double absoluteTolerance
Definition: AlgLoop.h:109
#define logError(msg)
Definition: Logging.h:102
static int nlsKinsolResiduals(N_Vector u, N_Vector fval, void *user_data)
Residual function for KINSOL.
Definition: AlgLoop.cpp:191
std::string dumpLoopVars(DirectedGraph &graph)
Dump variables of algebraic loop.
Definition: AlgLoop.cpp:641
ComRef pop_front()
returns the first part of the ComRef and removed it from the current object
Definition: ComRef.cpp:184
std::vector< std::pair< int, int > > connections
Definition: DirectedGraph.h:55
const std::vector< Connector > & getNodes() const
Definition: DirectedGraph.h:81
SUNMatrix J
Definition: AlgLoop.h:81
const scc_t SCC
Strong connected components.
Definition: AlgLoop.h:107
int size
Definition: AlgLoop.h:76
const int systNumber
Definition: AlgLoop.h:108