Skip to content

Commit

Permalink
Residual user data struct instead of void** (#9079)
Browse files Browse the repository at this point in the history 
* Residual user data struct instead of void**
  • Loading branch information
@AnHeuermann
AnHeuermann committed Jun 10, 2022
1 parent a983f48 commit 5d37593
Show file tree
Hide file tree
Showing 13 changed files with 96 additions and 87 deletions.
48 changes: 24 additions & 24 deletions OMCompiler/Compiler/Template/CodegenC.tpl
View file
Expand Up @@ -2333,11 +2333,11 @@ template functionSetupLinearSystemsTemp(list<SimEqSystem> linearSystems, String
<%auxFunction%>
<%tmp%>

void residualFunc<%ls.index%>(void** dataIn, const double* xloc, double* res, const int* iflag)
void residualFunc<%ls.index%>(RESIDUAL_USERDATA* userData, const double* xloc, double* res, const int* iflag)
{
TRACE_PUSH
DATA *data = (DATA*) ((void**)dataIn[0]);
threadData_t *threadData = (threadData_t*) ((void**)dataIn[1]);
DATA *data = userData->data;
threadData_t *threadData = userData->threadData;
const int equationIndexes[2] = {1,<%ls.index%>};
<% if ls.partOfJac then
'ANALYTIC_JACOBIAN* parentJacobian = data->simulationInfo->linearSystemData[<%ls.indexLinearSystem%>].parDynamicData[omc_get_thread_num()].parentJacobian;'
Expand Down Expand Up @@ -2474,11 +2474,11 @@ template functionSetupLinearSystemsTemp(list<SimEqSystem> linearSystems, String
<%auxFunction%>
<%tmp%>

void residualFunc<%ls.index%>(void** dataIn, const double* xloc, double* res, const int* iflag)
void residualFunc<%ls.index%>(RESIDUAL_USERDATA* userData, const double* xloc, double* res, const int* iflag)
{
TRACE_PUSH
DATA *data = (DATA*) ((void**)dataIn[0]);
threadData_t *threadData = (threadData_t*) ((void**)dataIn[1]);
DATA *data = userData->data;
threadData_t *threadData = userData->threadData;
const int equationIndexes[2] = {1,<%ls.index%>};
<% if ls.partOfJac then
'ANALYTIC_JACOBIAN* parentJacobian = data->simulationInfo->linearSystemData[<%ls.indexLinearSystem%>].parDynamicData[omc_get_thread_num()].parentJacobian;'
Expand All @@ -2505,11 +2505,11 @@ template functionSetupLinearSystemsTemp(list<SimEqSystem> linearSystems, String
<%auxFunction2%>
<%tmp2%>

void residualFunc<%at.index%>(void** dataIn, const double* xloc, double* res, const int* iflag)
void residualFunc<%at.index%>(RESIDUAL_USERDATA* userData, const double* xloc, double* res, const int* iflag)
{
TRACE_PUSH
DATA *data = (DATA*) ((void**)dataIn[0]);
threadData_t *threadData = (threadData_t*) ((void**)dataIn[1]);
DATA *data = userData->data;
threadData_t *threadData = userData->threadData;
const int equationIndexes[2] = {1,<%at.index%>};
<% if ls.partOfJac then
'ANALYTIC_JACOBIAN* parentJacobian = data->simulationInfo->linearSystemData[<%ls.indexLinearSystem%>].parDynamicData[omc_get_thread_num()].parentJacobian;'
Expand Down Expand Up @@ -2883,8 +2883,8 @@ end functionNonLinearResidualsMultiFile2;
template getNLSPrototypes(Integer index)
::=
<<
void residualFunc<%index%>(void** dataIn, const double* xloc, double* res, const int* iflag);
void initializeStaticDataNLS<%index%>(void *inData, threadData_t *threadData, void *inSystemData, modelica_boolean initSparsPattern);
void residualFunc<%index%>(RESIDUAL_USERDATA* userData, const double* xloc, double* res, const int* iflag);
void initializeStaticDataNLS<%index%>(void *inData, threadData_t *threadData, NONLINEAR_SYSTEM_DATA *inSystemData, modelica_boolean initSparsPattern);
void getIterationVarsNLS<%index%>(struct DATA *inData, double *array);
>>
end getNLSPrototypes;
Expand All @@ -2903,7 +2903,7 @@ template functionNonLinearResiduals(list<SimEqSystem> nonlinearSystems, String m
let residualFunction = generateNonLinearResidualFunction(nls, modelNamePrefix, 0)
let indexName = 'NLS<%nls.index%>'
let sparseData = generateStaticSparseData(indexName, 'NONLINEAR_SYSTEM_DATA', sparsePattern, colorList, maxColor)
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName)
let updateIterationVars = getIterationVars(nls.crefs, indexName)
let &prototypes += getNLSPrototypes(nls.index)
<<
Expand All @@ -2916,7 +2916,7 @@ template functionNonLinearResiduals(list<SimEqSystem> nonlinearSystems, String m
let residualFunction = generateNonLinearResidualFunction(nls, modelNamePrefix, 0)
let indexName = 'NLS<%nls.index%>'
let sparseData = generateStaticEmptySparseData(indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName)
let updateIterationVars = getIterationVars(nls.crefs, indexName)
let &prototypes += getNLSPrototypes(nls.index)
<<
Expand All @@ -2935,13 +2935,13 @@ template functionNonLinearResiduals(list<SimEqSystem> nonlinearSystems, String m
let residualFunction = generateNonLinearResidualFunction(nls, modelNamePrefix, 0)
let indexName = 'NLS<%nls.index%>'
let sparseData = generateStaticSparseData(indexName, 'NONLINEAR_SYSTEM_DATA', sparsePattern, colorList, maxColor)
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName)
let updateIterationVars = getIterationVars(nls.crefs, indexName)
// for casual tearing set
let residualFunctionCasual = generateNonLinearResidualFunction(at, modelNamePrefix, 1)
let indexName = 'NLS<%at.index%>'
let sparseDataCasual = generateStaticSparseData(indexName, 'NONLINEAR_SYSTEM_DATA', sparsePattern, colorList, maxColor)
let bodyStaticDataCasual = generateStaticInitialData(at.crefs, indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticDataCasual = generateStaticInitialData(at.crefs, indexName)
let updateIterationVarsCasual = getIterationVars(at.crefs, indexName)
let &prototypes += getNLSPrototypes(nls.index)
<<
Expand All @@ -2965,13 +2965,13 @@ template functionNonLinearResiduals(list<SimEqSystem> nonlinearSystems, String m
let residualFunction = generateNonLinearResidualFunction(nls, modelNamePrefix, 0)
let indexName = 'NLS<%nls.index%>'
let sparseData = generateStaticEmptySparseData(indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticData = generateStaticInitialData(nls.crefs, indexName)
let updateIterationVars = getIterationVars(nls.crefs, indexName)
// for casual tearing set
let residualFunctionCasual = generateNonLinearResidualFunction(at, modelNamePrefix, 1)
let indexName = 'NLS<%at.index%>'
let sparseDataCasual = generateStaticEmptySparseData(indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticDataCasual = generateStaticInitialData(at.crefs, indexName, 'NONLINEAR_SYSTEM_DATA')
let bodyStaticDataCasual = generateStaticInitialData(at.crefs, indexName)
let updateIterationVarsCasual = getIterationVars(at.crefs, indexName)
let &prototypes += getNLSPrototypes(nls.index)
<<
Expand Down Expand Up @@ -3046,9 +3046,9 @@ match system
;separator="\n")
let residualFunctionHeader =
if intEq(whichSet, 0) then
'void residualFunc<%nls.index%>(void** dataIn, const double* xloc, double* res, const int* iflag)'
'void residualFunc<%nls.index%>(RESIDUAL_USERDATA* userData, const double* xloc, double* res, const int* iflag)'
else
'int residualFuncConstraints<%nls.index%>(void** dataIn, const double* xloc, double* res, const int* iflag)'
'int residualFuncConstraints<%nls.index%>(RESIDUAL_USERDATA* userData, const double* xloc, double* res, const int* iflag)'
let returnValue = if intEq(whichSet, 1) then 'return 0;'
<<
<%innerNLSSystems%>
Expand All @@ -3059,8 +3059,8 @@ match system
<%residualFunctionHeader%>
{
TRACE_PUSH
DATA *data = (DATA*) ((void**)dataIn[0]);
threadData_t *threadData = (threadData_t*) ((void**)dataIn[1]);
DATA *data = userData->data;
threadData_t *threadData = userData->threadData;
const int equationIndexes[2] = {1,<%nls.index%>};
int i;<% if clockIndex then <<
const int clockIndex = <%clockIndex%>;
Expand Down Expand Up @@ -3158,9 +3158,10 @@ template generateStaticSparseData(String indexName, String systemType, SparsityP
end match
end generateStaticSparseData;
template generateStaticInitialData(list<ComponentRef> crefs, String indexName, String systemType)
template generateStaticInitialData(list<ComponentRef> crefs, String indexName)
"Generates initial function for nonlinear loops."
::=
let systemType = 'NONLINEAR_SYSTEM_DATA'
let bodyStaticData = (crefs |> cr hasindex i0 =>
<<
/* static nls data for <%crefStrNoUnderscore(cr)%> */
Expand All @@ -3172,10 +3173,9 @@ template generateStaticInitialData(list<ComponentRef> crefs, String indexName, S
<<
OMC_DISABLE_OPT
void initializeStaticData<%indexName%>(void *inData, threadData_t *threadData, void *inSystemData, modelica_boolean initSparsPattern)
void initializeStaticData<%indexName%>(void *inData, threadData_t *threadData, NONLINEAR_SYSTEM_DATA *sysData, modelica_boolean initSparsPattern)
{
DATA* data = (DATA*) inData;
<%systemType%>* sysData = (<%systemType%>*) inSystemData;
int i=0;
<%bodyStaticData%>
/* initial sparse pattern */
Expand Down
8 changes: 4 additions & 4 deletions OMCompiler/SimulationRuntime/c/simulation/solver/cvode_solver.c
View file
Expand Up @@ -513,7 +513,7 @@ void cvodeGetConfig(CVODE_CONFIG *config, threadData_t *threadData, booleantype
/**
* @brief Allocate memory, initialize and set configurations for CVODE solver
*
* @param data Runtime data struckt
* @param data Runtime data struct
* @param threadData Thread data for error handling
* @param solverInfo Information about main solver. Unused at the moment.
* @param cvodeData CVODE solver data struckt.
Expand Down Expand Up @@ -713,7 +713,7 @@ int cvode_solver_initial(DATA *data, threadData_t *threadData, SOLVER_INFO *solv
* Provide required problem specifications and reinitialize CVODE.
* If scaling is used y will be scaled accordingly.
*
* @param data Runtime data struckt.
* @param data Runtime data struct.
* @param threadData Thread data for error handling.
* @param solverInfo Information about main solver. Unused at the moment.
* @param cvodeData CVODE solver data struckt.
Expand Down Expand Up @@ -846,7 +846,7 @@ void cvode_save_statistics(void *cvode_mem, unsigned int *solverStatsTmp, thread
*
* Integrates on current time intervall.
*
* @param data Runtime data struckt
* @param data Runtime data struct
* @param threadData Thread data for error handling
* @param cvodeData CVODE solver data struckt.
* @return int Returns 0 on success and return flag from CVode else.
Expand Down Expand Up @@ -993,7 +993,7 @@ int cvode_solver_step(DATA *data, threadData_t *threadData, SOLVER_INFO *solverI
/**
* @brief Integration step with CVODE for fmi2DoStep
*
* @param data Runtime data struckt
* @param data Runtime data struct
* @param threadData Thread data for error handling.
* @param solverInfo CVODE solver data struckt.
* @param tNext Next desired time step for integrator to end.
Expand Down
4 changes: 2 additions & 2 deletions OMCompiler/SimulationRuntime/c/simulation/solver/kinsolSolver.c
View file
Expand Up @@ -293,9 +293,9 @@ static int nlsKinsolResiduals(N_Vector x, N_Vector f, void* userData) {
NLS_USERDATA* kinsolUserData = (NLS_USERDATA*)userData;
DATA* data = kinsolUserData->data;
threadData_t* threadData = kinsolUserData->threadData;
void* dataAndThreadData[2] = {data, threadData};
NONLINEAR_SYSTEM_DATA* nlsData = kinsolUserData->nlsData;
NLS_KINSOL_DATA* kinsolData = (NLS_KINSOL_DATA*)nlsData->solverData;
RESIDUAL_USERDATA resUserData = {.data=data, .threadData=threadData, .solverData=NULL};
int iflag = 1 /* recoverable error */;

/* Update statistics */
Expand All @@ -306,7 +306,7 @@ static int nlsKinsolResiduals(N_Vector x, N_Vector f, void* userData) {
#endif

/* call residual function */
nlsData->residualFunc(dataAndThreadData, xdata, fdata, (const int *)&iflag);
nlsData->residualFunc(&resUserData, xdata, fdata, (const int *)&iflag);
iflag = 0 /* success */;

#ifndef OMC_EMCC
Expand Down
11 changes: 5 additions & 6 deletions OMCompiler/SimulationRuntime/c/simulation/solver/linearSolverKlu.c
View file
Expand Up @@ -168,11 +168,10 @@ static int getAnalyticalJacobian(DATA* data, threadData_t *threadData,
/*! \fn residual_wrapper for the residual function
*
*/
static int residual_wrapper(double* x, double* f, void** data, int sysNumber)
static int residual_wrapper(double* x, double* f, RESIDUAL_USERDATA* userData, int sysNumber)
{
int iflag = 0;

(*((DATA*)data[0])->simulationInfo->linearSystemData[sysNumber].residualFunc)(data, x, f, &iflag);
userData->data->simulationInfo->linearSystemData[sysNumber].residualFunc(userData, x, f, &iflag);
return 0;
}

Expand All @@ -186,7 +185,7 @@ static int residual_wrapper(double* x, double* f, void** data, int sysNumber)
*/
int solveKlu(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)
{
void *dataAndThreadData[2] = {data, threadData};
RESIDUAL_USERDATA resUserData = {.data=data, .threadData=threadData, .solverData=NULL};
LINEAR_SYSTEM_DATA* systemData = &(data->simulationInfo->linearSystemData[sysNumber]);
DATA_KLU* solverData = (DATA_KLU*)systemData->parDynamicData[omc_get_thread_num()].solverData[0];
_omc_scalar residualNorm = 0;
Expand Down Expand Up @@ -227,7 +226,7 @@ int solveKlu(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)
/* calculate vector b (rhs) */
memcpy(solverData->work, aux_x, sizeof(double)*solverData->n_row);

residual_wrapper(solverData->work, systemData->parDynamicData[omc_get_thread_num()].b, dataAndThreadData, sysNumber);
residual_wrapper(solverData->work, systemData->parDynamicData[omc_get_thread_num()].b, &resUserData, sysNumber);
}
tmpJacEvalTime = rt_ext_tp_tock(&(solverData->timeClock));
systemData->jacobianTime += tmpJacEvalTime;
Expand Down Expand Up @@ -309,7 +308,7 @@ int solveKlu(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)
aux_x[i] += systemData->parDynamicData[omc_get_thread_num()].b[i];

/* update inner equations */
residual_wrapper(aux_x, solverData->work, dataAndThreadData, sysNumber);
residual_wrapper(aux_x, solverData->work, &resUserData, sysNumber);
residualNorm = _omc_gen_euclideanVectorNorm(solverData->work, solverData->n_row);

if ((isnan(residualNorm)) || (residualNorm>1e-4)){
Expand Down
10 changes: 5 additions & 5 deletions OMCompiler/SimulationRuntime/c/simulation/solver/linearSolverLapack.c
View file
Expand Up @@ -153,11 +153,11 @@ int getAnalyticalJacobianLapack(DATA* data, threadData_t *threadData, double* ja
/*! \fn wrapper_fvec_lapack for the residual function
*
*/
static int wrapper_fvec_lapack(_omc_vector* x, _omc_vector* f, int* iflag, void** data, int sysNumber)
static int wrapper_fvec_lapack(_omc_vector* x, _omc_vector* f, int* iflag, RESIDUAL_USERDATA* resUserData, int sysNumber)
{
int currentSys = sysNumber;

(*((DATA*)data[0])->simulationInfo->linearSystemData[currentSys].residualFunc)(data, x->data, f->data, iflag);
resUserData->data->simulationInfo->linearSystemData[currentSys].residualFunc(resUserData, x->data, f->data, iflag);
return 0;
}

Expand All @@ -170,7 +170,7 @@ static int wrapper_fvec_lapack(_omc_vector* x, _omc_vector* f, int* iflag, void*
*/
int solveLapack(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)
{
void *dataAndThreadData[2] = {data, threadData};
RESIDUAL_USERDATA resUserData = {.data=data, .threadData=threadData, .solverData=NULL};
int i, iflag = 1;
LINEAR_SYSTEM_DATA* systemData = &(data->simulationInfo->linearSystemData[sysNumber]);

Expand Down Expand Up @@ -219,7 +219,7 @@ int solveLapack(DATA *data, threadData_t *threadData, int sysNumber, double* aux
/* calculate vector b (rhs) */
_omc_copyVector(solverData->work, solverData->x);

wrapper_fvec_lapack(solverData->work, solverData->b, &iflag, dataAndThreadData, sysNumber);
wrapper_fvec_lapack(solverData->work, solverData->b, &iflag, &resUserData, sysNumber);
}
tmpJacEvalTime = rt_ext_tp_tock(&(solverData->timeClock));
systemData->jacobianTime += tmpJacEvalTime;
Expand Down Expand Up @@ -294,7 +294,7 @@ int solveLapack(DATA *data, threadData_t *threadData, int sysNumber, double* aux
solverData->x = _omc_addVectorVector(solverData->x, solverData->work, solverData->b); // x = xold(work) + xnew(b)

/* update inner equations */
wrapper_fvec_lapack(solverData->x, solverData->work, &iflag, dataAndThreadData, sysNumber);
wrapper_fvec_lapack(solverData->x, solverData->work, &iflag, &resUserData, sysNumber);
residualNorm = _omc_euclideanVectorNorm(solverData->work);

if ((isnan(residualNorm)) || (residualNorm>1e-4)){
Expand Down
10 changes: 5 additions & 5 deletions OMCompiler/SimulationRuntime/c/simulation/solver/linearSolverLis.c
View file
Expand Up @@ -183,11 +183,11 @@ int getAnalyticalJacobianLis(DATA* data, threadData_t *threadData, int sysNumber
/*! \fn wrapper_fvec_lis for the residual function
*
*/
static int wrapper_fvec_lis(double* x, double* f, void** data, int sysNumber)
static int wrapper_fvec_lis(double* x, double* f, RESIDUAL_USERDATA* resUserData , int sysNumber)
{
int iflag = 0;

(*((DATA*)data[0])->simulationInfo->linearSystemData[sysNumber].residualFunc)(data, x, f, &iflag);
resUserData->data->simulationInfo->linearSystemData[sysNumber].residualFunc(resUserData, x, f, &iflag);
return 0;
}

Expand All @@ -200,7 +200,7 @@ static int wrapper_fvec_lis(double* x, double* f, void** data, int sysNumber)
*/
int solveLis(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)
{
void *dataAndThreadData[2] = {data, threadData};
RESIDUAL_USERDATA resUserData = {.data=data, .threadData=threadData, .solverData=NULL};
LINEAR_SYSTEM_DATA* systemData = &(data->simulationInfo->linearSystemData[sysNumber]);
DATA_LIS* solverData = (DATA_LIS*)systemData->parDynamicData[omc_get_thread_num()].solverData[0];

Expand Down Expand Up @@ -243,7 +243,7 @@ int solveLis(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)

/* calculate vector b (rhs) */
memcpy(solverData->work, aux_x, sizeof(double)*solverData->n_row);
wrapper_fvec_lis(solverData->work, systemData->parDynamicData[omc_get_thread_num()].b, dataAndThreadData, sysNumber);
wrapper_fvec_lis(solverData->work, systemData->parDynamicData[omc_get_thread_num()].b, &resUserData, sysNumber);

/* set b vector */
for(i=0; i<n; i++) {
Expand Down Expand Up @@ -294,7 +294,7 @@ int solveLis(DATA *data, threadData_t *threadData, int sysNumber, double* aux_x)
aux_x[i] += solverData->work[i];

/* update inner equations */
wrapper_fvec_lis(aux_x, solverData->work, dataAndThreadData, sysNumber);
wrapper_fvec_lis(aux_x, solverData->work, &resUserData, sysNumber);
residualNorm = _omc_gen_euclideanVectorNorm(solverData->work, solverData->n_row);

if ((isnan(residualNorm)) || (residualNorm>1e-4)){
Expand Down

0 comments on commit 5d37593

Please sign in to comment.