Skip to content

Commit

Permalink
[janitor] Cleanup events.c (#8956)
Browse files Browse the repository at this point in the history 
* [janitor] Cleanup events.c

- make tmpEventList truly static (no malloc)
- stop returning confusing double from bisection

* Fix array management

* Modularize findRoot

- suggested by bernhardbachmann
  • Loading branch information
@phannebohm
phannebohm committed May 16, 2022
1 parent 627bacf commit caa3fcc
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 84 deletions.
110 changes: 45 additions & 65 deletions OMCompiler/SimulationRuntime/c/simulation/solver/events.c
View file
Expand Up @@ -51,12 +51,10 @@ extern "C" {
#endif

int maxBisectionIterations = 0;
double bisection(DATA* data, threadData_t *threadData, double*, double*, double*, double*, LIST*, LIST*);
void bisection(DATA* data, threadData_t *threadData, double*, double*, double*, double*, LIST*, LIST*);
int checkZeroCrossings(DATA *data, LIST *list, LIST*);
void saveZeroCrossingsAfterEvent(DATA *data, threadData_t *threadData);

int checkForStateEvent(DATA* data, LIST *eventList);

/*! \fn checkForSampleEvent
*
* \param [ref] [data]
Expand Down Expand Up @@ -150,12 +148,10 @@ int checkEvents(DATA* data, threadData_t *threadData, LIST* eventLst, modelica_b
{
TRACE_PUSH

if (checkForStateEvent(data, eventLst))
int found = checkForStateEvent(data, eventLst);
if(found && useRootFinding)
{
if (useRootFinding)
{
*eventTime = findRoot(data, threadData, eventLst);
}
*eventTime = findRoot(data, threadData, eventLst, data->simulationInfo->timeValueOld, data->simulationInfo->realVarsOld, data->localData[0]->timeValue, data->localData[0]->realVars);
}

if(data->simulationInfo->sampleActivated == 1)
Expand Down Expand Up @@ -288,44 +284,50 @@ void handleEvents(DATA* data, threadData_t *threadData, LIST* eventLst, double *
* \param [ref] [data]
* \param [ref] [threadData]
* \param [ref] [eventList]
* \return: first event of interval [oldTime, timeValue]
*
* This function perform a root finding for interval = [oldTime, timeValue]
* \param [in] [time_left]
* \param [in] [values_left]
* \param [in] [time_right]
* \param [in] [values_right]
* \return: first event of interval [time_left, time_right]
*/
double findRoot(DATA* data, threadData_t *threadData, LIST *eventList)
double findRoot(DATA* data, threadData_t* threadData, LIST* eventList, double time_left, double* values_left, double time_right, double* values_right)
{
TRACE_PUSH

double eventTime;
long event_id;
LIST_NODE* it;
fortran_integer i=0;
static LIST *tmpEventList = NULL;
static LIST tmpEventList = (LIST){NULL, NULL, sizeof(long), 0};

double *states_right = (double*) malloc(data->modelData->nStates * sizeof(double));
double *states_left = (double*) malloc(data->modelData->nStates * sizeof(double));
/* static work arrays */
static double *states_left = NULL;
static double *states_right = NULL;

double time_left = data->simulationInfo->timeValueOld;
double time_right = data->localData[0]->timeValue;

tmpEventList = allocList(sizeof(long));
/* allocate memory once at first call, never free */
if(!states_left)
{
states_left = (double*) malloc(data->modelData->nStates * sizeof(double));
assertStreamPrint(NULL, NULL != states_left, "out of memory");
}
if(!states_right)
{
states_right = (double*) malloc(data->modelData->nStates * sizeof(double));
assertStreamPrint(NULL, NULL != states_right, "out of memory");
}

assert(states_right);
assert(states_left);
/* write states to work arrays */
memcpy(states_left, values_left, data->modelData->nStates * sizeof(double));
memcpy(states_right, values_right, data->modelData->nStates * sizeof(double));

for(it=listFirstNode(eventList); it; it=listNextNode(it))
{
infoStreamPrint(LOG_ZEROCROSSINGS, 0, "search for current event. Events in list: %ld", *((long*)listNodeData(it)));
}

/* write states to work arrays */
memcpy(states_left, data->simulationInfo->realVarsOld, data->modelData->nStates * sizeof(double));
memcpy(states_right, data->localData[0]->realVars , data->modelData->nStates * sizeof(double));

/* Search for event time and event_id with bisection method */
eventTime = bisection(data, threadData, &time_left, &time_right, states_left, states_right, tmpEventList, eventList);
bisection(data, threadData, &time_left, &time_right, states_left, states_right, &tmpEventList, eventList);

if(listLen(tmpEventList) == 0)
/* what happens here? */
if(listLen(&tmpEventList) == 0)
{
double value = fabs(data->simulationInfo->zeroCrossings[*((long*) listFirstData(eventList))]);
for(it = listFirstNode(eventList); it; it = listNextNode(it))
Expand All @@ -341,59 +343,40 @@ double findRoot(DATA* data, threadData_t *threadData, LIST *eventList)
{
if(value == fabs(data->simulationInfo->zeroCrossings[*((long*) listNodeData(it))]))
{
listPushBack(tmpEventList, listNodeData(it));
listPushBack(&tmpEventList, listNodeData(it));
infoStreamPrint(LOG_ZEROCROSSINGS, 0, "added tmp event : %ld", *((long*) listNodeData(it)));
}
}
}

listClear(eventList);

if(ACTIVE_STREAM(LOG_EVENTS))
{
if(listLen(tmpEventList) > 0)
{
debugStreamPrint(LOG_EVENTS, 0, "found events: ");
}
else
{
debugStreamPrint(LOG_EVENTS, 0, "found event: ");
}
}
while(listLen(tmpEventList) > 0)
debugStreamPrint(LOG_EVENTS, 0, (listLen(&tmpEventList) == 1) ? "found event: " : "found events: ");
while(listLen(&tmpEventList) > 0)
{
event_id = *((long*)listFirstData(tmpEventList));
listPopFront(tmpEventList);

infoStreamPrint(LOG_ZEROCROSSINGS, 0, "Event id: %ld ", event_id);

/* TODO do this directly w/o free-malloc */
long event_id = *((long*)listFirstData(&tmpEventList));
listPopFront(&tmpEventList);
listPushFront(eventList, &event_id);

infoStreamPrint(LOG_ZEROCROSSINGS, 0, "Event id: %ld", event_id);
}

eventTime = time_right;
debugStreamPrint(LOG_EVENTS, 0, "time: %.10e", eventTime);
debugStreamPrint(LOG_EVENTS, 0, "time: %.10e", time_right);

data->localData[0]->timeValue = time_left;
for(i=0; i < data->modelData->nStates; i++) {
data->localData[0]->realVars[i] = states_left[i];
}
memcpy(data->localData[0]->realVars, states_left, data->modelData->nStates * sizeof(double));

/* determined continuous system */
data->callback->updateContinuousSystem(data, threadData);
updateRelationsPre(data);
/*sim_result_emit(data);*/

data->localData[0]->timeValue = eventTime;
for(i=0; i < data->modelData->nStates; i++)
{
data->localData[0]->realVars[i] = states_right[i];
}

free(states_left);
free(states_right);
data->localData[0]->timeValue = time_right;
memcpy(data->localData[0]->realVars, states_right, data->modelData->nStates * sizeof(double));

TRACE_POP
return eventTime;
return time_right;
}

/*! \fn bisection
Expand All @@ -405,11 +388,10 @@ double findRoot(DATA* data, threadData_t *threadData, LIST *eventList)
* \param [ref] [states_b]
* \param [ref] [eventListTmp]
* \param [in] [eventList]
* \return Founded event time
*
* Method to find root in interval [oldTime, timeValue]
*/
double bisection(DATA* data, threadData_t *threadData, double* a, double* b, double* states_a, double* states_b, LIST *tmpEventList, LIST *eventList)
void bisection(DATA* data, threadData_t *threadData, double* a, double* b, double* states_a, double* states_b, LIST *tmpEventList, LIST *eventList)
{
TRACE_PUSH

Expand Down Expand Up @@ -458,10 +440,8 @@ double bisection(DATA* data, threadData_t *threadData, double* a, double* b, dou
memcpy(data->simulationInfo->zeroCrossings, data->simulationInfo->zeroCrossingsBackup, data->modelData->nZeroCrossings * sizeof(modelica_real));
}
}
c = 0.5*(*a + *b);

TRACE_POP
return c;
}

/*! \fn checkZeroCrossings
Expand Down
2 changes: 1 addition & 1 deletion OMCompiler/SimulationRuntime/c/simulation/solver/events.h
View file
Expand Up @@ -49,7 +49,7 @@ int checkEvents(DATA* data, threadData_t *threadData, LIST* eventLst, modelica_b

void handleEvents(DATA* data, threadData_t *threadData, LIST* eventLst, double *eventTime, SOLVER_INFO* solverInfo);

double findRoot(DATA *data, threadData_t *threadData, LIST *eventList);
double findRoot(DATA* data, threadData_t* threadData, LIST* eventList, double time_left, double* states_left, double time_right, double* states_right);

#ifdef __cplusplus
}
Expand Down
13 changes: 0 additions & 13 deletions OMCompiler/SimulationRuntime/c/util/list.c
View file
Expand Up @@ -40,19 +40,6 @@
#include <stdlib.h>
#include <string.h>

struct LIST_NODE
{
void *data;
LIST_NODE *next;
};

struct LIST
{
LIST_NODE *first;
LIST_NODE *last;
unsigned int itemSize;
unsigned int length;
};

LIST *allocList(unsigned int itemSize)
{
Expand Down
16 changes: 12 additions & 4 deletions OMCompiler/SimulationRuntime/c/util/list.h
View file
Expand Up @@ -42,11 +42,19 @@ extern "C" {
#endif
/* type-free list */
struct LIST_NODE;
typedef struct LIST_NODE LIST_NODE;
typedef struct LIST_NODE
{
void *data;
struct LIST_NODE *next;
} LIST_NODE;

struct LIST;
typedef struct LIST LIST;
typedef struct LIST
{
LIST_NODE *first;
LIST_NODE *last;
unsigned int itemSize;
unsigned int length;
} LIST;

LIST *allocList(unsigned int itemSize);
void freeList(LIST *list);
Expand Down
2 changes: 1 addition & 1 deletion testsuite/simulation/modelica/algorithms_functions/ZeroCross.mos
View file
Expand Up @@ -3,7 +3,7 @@
// status: correct
// teardown_command: rm -rf ZeroCrossAlg* output.log *.conv.cpp
// cflags: -d=-newInst
//
//
// Simulate model containing ZeroCrossing in for loop algorithm
//
loadFile("./ZeroCross.mo");
Expand Down

0 comments on commit caa3fcc

Please sign in to comment.