123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351 |
- /*
- * This file is part of OpenModelica.
- *
- * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
- * c/o Linköpings universitet, Department of Computer and Information Science,
- * SE-58183 Linköping, Sweden.
- *
- * All rights reserved.
- *
- * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF THE BSD NEW LICENSE OR THE
- * GPL VERSION 3 LICENSE OR THE OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
- * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
- * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
- * ACCORDING TO RECIPIENTS CHOICE.
- *
- * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
- * Public License (OSMC-PL) are obtained from OSMC, either from the above
- * address, from the URLs: http://www.openmodelica.org or
- * http://www.ida.liu.se/projects/OpenModelica, and in the OpenModelica
- * distribution. GNU version 3 is obtained from:
- * http://www.gnu.org/copyleft/gpl.html. The New BSD License is obtained from:
- * http://www.opensource.org/licenses/BSD-3-Clause.
- *
- * This program is distributed WITHOUT ANY WARRANTY; without even the implied
- * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, EXCEPT AS
- * EXPRESSLY SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE
- * CONDITIONS OF OSMC-PL.
- *
- */
- /* File: modelica.h
- * Description: This is the C header file for the C code generated from
- * Modelica. It includes e.g. the C object representation of the builtin types
- * and arrays, etc.
- */
- #ifndef OPENMODELICAFUNC_H_
- #define OPENMODELICAFUNC_H_
- #ifdef __cplusplus
- extern "C" {
- #endif
- #include "simulation_data.h"
- #include "gc/omc_gc.h"
- #include "util/index_spec.h"
- #include "util/boolean_array.h"
- #include "util/integer_array.h"
- #include "util/real_array.h"
- #include "util/string_array.h"
- #include "util/modelica_string.h"
- #include "util/division.h"
- #include "util/utility.h"
- struct OpenModelicaGeneratedFunctionCallbacks {
- /* Defined in perform_simulation.c and omp_perform_simulation.c */
- int (*performSimulation)(DATA* data, threadData_t*, void* solverInfo);
- int (*performQSSSimulation)(DATA* data, threadData_t*, void* solverInfo);
- void (*updateContinuousSystem)(DATA *data, threadData_t*);
- /* Function for calling external object constructors */
- void (*callExternalObjectConstructors)(DATA *data, threadData_t*);
- /* Function for calling external object deconstructors */
- void (*callExternalObjectDestructors)(DATA *_data, threadData_t*);
- /*! \fn initialNonLinearSystem
- *
- * This function initialize nonlinear system structure.
- *
- * \param [ref] [data]
- */
- void (*initialNonLinearSystem)(int nNonLinearSystems, NONLINEAR_SYSTEM_DATA *data);
- /*! \fn initialLinearSystem
- *
- * This function initialize nonlinear system structure.
- *
- * \param [ref] [data]
- */
- void (*initialLinearSystem)(int nLinearSystems, LINEAR_SYSTEM_DATA *data);
- /*! \fn initialNonLinearSystem
- *
- * This function initialize nonlinear system structure.
- *
- * \param [ref] [data]
- */
- void (*initialMixedSystem)(int nMixedSystems, MIXED_SYSTEM_DATA *data);
- /*! \fn initialNonLinearSystem
- *
- * This function initialize state set structure.
- *
- * \param [ref] [data]
- */
- void (*initializeStateSets)(int nStateSets, STATE_SET_DATA* statesetData, DATA *data);
- /*! \fn initializeDAEmodeData
- *
- * This function to initialize the daeMode data structure in Data
- *
- * \param [ref] [data]
- */
- int (*initializeDAEmodeData)(DATA *data, DAEMODE_DATA* daeModeData);
- /* functionODE contains those equations that are needed
- * to calculate the dynamic part of the system */
- int (*functionODE)(DATA *data, threadData_t*);
- /* functionAlgebraics contains all continuous equations that
- * are not part of the dynamic part of the system */
- int (*functionAlgebraics)(DATA *data, threadData_t*);
- /* function for calculating all equation sorting order
- uses in EventHandle */
- int (*functionDAE)(DATA *data, threadData_t*);
- /* function that evaluates all localKnownVars */
- int (*functionLocalKnownVars)(DATA *data, threadData_t*);
- /* functions for input and output */
- int (*input_function)(DATA*, threadData_t*);
- int (*input_function_init)(DATA*, threadData_t*);
- int (*input_function_updateStartValues)(DATA*, threadData_t*);
- int (*output_function)(DATA*, threadData_t*);
- /* function for storing value histories of delayed expressions
- * called from functionDAE_output()
- */
- int (*function_storeDelayed)(DATA *data, threadData_t*);
- /*! \fn updateBoundVariableAttributes
- *
- * This function updates all bound start, nominal, min, and max values.
- *
- * \param [ref] [data]
- */
- int (*updateBoundVariableAttributes)(DATA *data, threadData_t*);
- /*! \var useHomotopy
- *
- * is 1 if homotopy(...) is used during initialization, otherwise 0
- */
- const int useHomotopy;
- /*! \fn functionInitialEquations
- *
- * function for calculate initial values from the initial equations and initial algorithms
- *
- * \param [ref] [data]
- */
- int (*functionInitialEquations)(DATA *data, threadData_t*);
- /*! \fn functionInitialEquations_lambda0
- *
- * function for calculate initial values from the initial equations and initial algorithms
- *
- * \param [ref] [data]
- */
- int (*functionInitialEquations_lambda0)(DATA *data, threadData_t*);
- /*! \fn functionRemovedInitialEquations
- *
- * This function contains removed equations from the initialization problem,
- * which need to be checked to verify the consistency of the initialization
- * problem.
- *
- * \param [ref] [data]
- */
- int (*functionRemovedInitialEquations)(DATA *data, threadData_t*);
- /*! \fn updateBoundParameters
- *
- * This function calculates bound parameters that depend on other parameters,
- * e.g. parameter Real n=1/m;
- * obsolete: bound_parameters
- *
- * \param [ref] [data]
- */
- int (*updateBoundParameters)(DATA *data, threadData_t*);
- /* function for checking for asserts and terminate */
- int (*checkForAsserts)(DATA *data, threadData_t*);
- /*! \fn function_ZeroCrossingsEquations
- *
- * This function updates all equations to evaluate function_ZeroCrossings
- *
- * \param [ref] [data]
- */
- int (*function_ZeroCrossingsEquations)(DATA *data, threadData_t*);
- /*! \fn function_ZeroCrossings
- *
- * This function evaluates if a sign change occurs at the current state
- *
- * \param [ref] [data]
- * \param [ref] [gout]
- */
- int (*function_ZeroCrossings)(DATA *data, threadData_t*, double* gout);
- /*! \fn function_updateRelations
- *
- * This function evaluates current continuous relations.
- *
- * \param [ref] [data]
- * \param [in] [evalZeroCross] flag for evaluating Relation with hysteresis
- * function or without
- */
- int (*function_updateRelations)(DATA *data, threadData_t*, int evalZeroCross);
- /*! \fn checkForDiscreteChanges
- *
- * This function checks if any discrete variable changed
- *
- * \param [ref] [data]
- */
- int (*checkForDiscreteChanges)(DATA *data, threadData_t*);
- /*! \var zeroCrossingDescription
- *
- * This variable contains a description string for zero crossing condition.
- */
- const char *(*zeroCrossingDescription)(int i, int **out_EquationIndexes);
- /*! \var relationDescription
- *
- * This variable contains a description string for continuous relations.
- */
- const char *(*relationDescription)(int i);
- /*! \fn function_initSample
- *
- * This function initialize the sample-info struct.
- *
- * \param [ref] [data]
- */
- void (*function_initSample)(DATA *data, threadData_t*);
- /* function for calculation Jacobian */
- /*#ifdef D_OMC_JACOBIAN*/
- const int INDEX_JAC_A;
- const int INDEX_JAC_B;
- const int INDEX_JAC_C;
- const int INDEX_JAC_D;
- /*
- * These functions initialize specific jacobians.
- * Return-value 0: jac is present
- * Return-value 1: jac is not present
- */
- int (*initialAnalyticJacobianA)(void* data, threadData_t *threadData);
- int (*initialAnalyticJacobianB)(void* data, threadData_t *threadData);
- int (*initialAnalyticJacobianC)(void* data, threadData_t *threadData);
- int (*initialAnalyticJacobianD)(void* data, threadData_t *threadData);
- /*
- * These functions calculate specific jacobian column.
- */
- int (*functionJacA_column)(void* data, threadData_t *threadData);
- int (*functionJacB_column)(void* data, threadData_t *threadData);
- int (*functionJacC_column)(void* data, threadData_t *threadData);
- int (*functionJacD_column)(void* data, threadData_t *threadData);
- /*#endif*/
- const char *(*linear_model_frame)(void); /* printf format-string with holes for 6 strings */
- const char *(*linear_model_datarecovery_frame)(void); /* printf format-string with holes for 9 strings */
- /*
- * This function is used only for optimization purpose
- * and calculates the mayer term. In case it's not present
- * a dummy function is added which return -1.
- */
- int (*mayer)(DATA* data, modelica_real** res, short *);
- /*
- * This function is used only for optimization purpose
- * and calculates the lagrange term. In case it's not present
- * a dummy function is added which return -1.
- */
- int (*lagrange)(DATA* data, modelica_real** res, short *, short *);
- /*
- * This function is used only for optimization purpose
- * and pick up the bounds of inputs. In case it's not present
- * a dummy function is added which return -1.
- */
- int (*pickUpBoundsForInputsInOptimization)(DATA* data, modelica_real* min, modelica_real* max, modelica_real*nominal,
- modelica_boolean *useNominal, char ** name, modelica_real * start, modelica_real * startTimeOpt);
- /*
- * This function is used only for optimization purpose
- * and set simulationInfo->inputVars. In case it's not present
- * a dummy function is added which return -1.
- */
- int (*setInputData)(DATA* data, const modelica_boolean file);
- /*
- * This function is used only for optimization purpose
- * and return the time gride. In case it's not present
- * a dummy function is added which return -1.
- */
- int (*getTimeGrid)(DATA *data, modelica_integer * nsi, modelica_real**t);
- /*
- * update parameter for symEuler
- */
- int (*symEulerUpdate)(DATA * data, modelica_real dt);
- /*
- * initialize clocks and subclocks info in modelData
- */
- void (*function_initSynchronous)(DATA * data, threadData_t *threadData);
- /*
- * Update clock interval.
- */
- void (*function_updateSynchronous)(DATA *data, threadData_t *threadData, long i);
- /*
- * Sub-partition's equations
- */
- int (*function_equationsSynchronous)(DATA *data, threadData_t *threadData, long i);
- /*
- * FMU's do not need the XML-file; they use this callback instead.
- */
- void (*read_input_fmu)(MODEL_DATA* modelData, SIMULATION_INFO* simulationData);
- /*
- * return input names
- */
- int (*inputNames)(DATA* modelData, char ** names);
- #ifdef FMU_EXPERIMENTAL
- /* functionODEPartial contains those equations that are needed
- * to calculate the state derivative i-th */
- void (*functionODEPartial)(DATA *data, threadData_t*, int i);
- void (*functionFMIJacobian)(DATA *data, threadData_t*, const unsigned *unknown, int nUnk, const unsigned *ders, int nKnown, double *dvKnown, double *out);
- #endif
- };
- #ifdef __cplusplus
- }
- #endif
- #endif
|