forked from modelica/ModelicaStandardLibrary
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ModelicaStandardTables.c
7465 lines (6749 loc) · 325 KB
/
ModelicaStandardTables.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ModelicaStandardTables.c - External table functions
Copyright (C) 2013-2021, Modelica Association and contributors
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/* Implementation of external functions for table computation
in the Modelica Standard Library:
Modelica.Blocks.Sources.CombiTimeTable
Modelica.Blocks.Tables.CombiTable1Ds
Modelica.Blocks.Tables.CombiTable1Dv
Modelica.Blocks.Tables.CombiTable2Ds
Modelica.Blocks.Tables.CombiTable2Dv
Changelog:
Jan. 31, 2022: by Hans Olsson, Dassault Systemes
Added better support for one-sided derivatives of CombiTable2D.
The idea is that when we are computing the derivative at a boundary
in the table we should consider the der-value to choose side.
This is less important for 1d-tables and thus ignored in those cases.
(ticket #3893)
Nov. 12, 2021: by Thomas Beutlich
Fixed derivatives in CombiTable2D for one-sided extrapolation
by constant continuation (ticket #3894)
Dec. 22, 2020: by Thomas Beutlich
Added reading of CSV files (ticket #1153)
May 27, 2020: by Thomas Beutlich
Fixed invalid memory access in error messages of
isValidCombiTimeTable and isValidCombiTable1D (ticket #3562)
Nov. 01, 2019: by Thomas Beutlich
Added univariate Makima-spline interpolation (ticket #1039)
Aug. 03, 2019: by Thomas Beutlich
Added second derivatives (ticket #2901)
Oct. 04, 2018: by Thomas Beutlich, ESI ITI GmbH
Fixed event detection of CombiTimeTable (ticket #2724)
Fixed left extrapolation of CombiTimeTable (ticket #2724)
Jan. 03, 2018: by Thomas Beutlich, ESI ITI GmbH
Improved reentrancy of CombiTimeTable (ticket #2411)
Oct. 23, 2017: by Thomas Beutlich, ESI ITI GmbH
Utilized non-fatal hash insertion, called by HASH_ADD_KEYPTR
in function readTable (ticket #2097)
Aug. 25, 2017: by Thomas Beutlich, ESI ITI GmbH
Added support for extrapolation in CombiTable2D (ticket #1839)
Apr. 24, 2017: by Thomas Beutlich, ESI ITI GmbH
Added functions to retrieve minimum and maximum abscissa
values of CombiTable2D (ticket #2244)
Apr. 15, 2017: by Thomas Beutlich, ESI ITI GmbH
Added support for time event generation (independent of
smoothness) in CombiTimeTable (ticket #2080)
Apr. 11, 2017: by Thomas Beutlich, ESI ITI GmbH
Revised initialization of CombiTimeTable, CombiTable1D
and CombiTable2D (ticket #1899)
- Already read table in the initialization functions
Apr. 07, 2017: by Thomas Beutlich, ESI ITI GmbH
Added support for shift time (independent of start time)
in CombiTimeTable (ticket #1771)
Apr. 05, 2017: by Thomas Beutlich, ESI ITI GmbH
Fixed extrapolation of CombiTimeTable if simulation start
time equals the maximum time of the table (ticket #2233)
Mar. 08, 2017: by Thomas Beutlich, ESI ITI GmbH
Moved file I/O functions to ModelicaIO (ticket #2192)
Feb. 25, 2017: by Thomas Beutlich, ESI ITI GmbH
Added support for extrapolation in CombiTable1D (ticket #1839)
Added functions to retrieve minimum and maximum abscissa
values of CombiTable1D (ticket #2120)
Aug. 10, 2016: by Thomas Beutlich, ESI ITI GmbH
Fixed event detection of CombiTimeTable for restarted
simulation (ticket #2040)
Fixed tracing time events (DEBUG_TIME_EVENTS) of CombiTimeTable
for negative simulation time
Dec. 16, 2015: by Thomas Beutlich, ITI GmbH
Added univariate Steffen-spline interpolation (ticket #1814)
Nov. 25, 2015: by Thomas Beutlich, ITI GmbH
Added support of struct variables of MATLAB MAT-files
(ticket #1840)
Nov. 16, 2015: by Thomas Beutlich, ITI GmbH
Fixed support of 2x3 and 3x2 2D tables with spline
interpolation (ticket #1820)
Nov. 03, 2015: by Thomas Beutlich, ITI GmbH
Added range checks for column indices of CombiTimeTable and
CombiTable1D (ticket #1816)
Aug. 31, 2015: by Thomas Beutlich, ITI GmbH
Fixed event detection of CombiTimeTable when using a fixed time
step integrator with a step size greater than the event
resolution of the table (ticket #1768)
May 11, 2015: by Thomas Beutlich, ITI GmbH
Added univariate Fritsch-Butland-spline interpolation
(ticket #1717)
Apr. 16, 2015: by Thomas Beutlich, ITI GmbH
Fixed event detection of CombiTimeTable with scaled time
(ticket #1627)
Mar. 18, 2015: by Thomas Beutlich, ITI GmbH
Fixed poor performance of readMatTable for MATLAB MAT-files with
compressed array streams and large (> 1e5) number of rows
(ticket #1682)
Jan. 02, 2015: by Thomas Beutlich, ITI GmbH
Fixed event detection of CombiTimeTable with non-zero start time
(ticket #1619)
Aug. 22, 2014: by Thomas Beutlich, ITI GmbH
Fixed multi-threaded access of common/shared table arrays
(ticket #1556)
Aug. 07, 2014: by Thomas Beutlich, ITI GmbH
Added pure C implementation of common/shared table arrays
(ticket #1550)
May 21, 2014: by Thomas Beutlich, ITI GmbH
Fixed bivariate Akima-spline extrapolation (ticket #1465)
Improved error message in case of trailing numbers when parsing
a line of a text file (ticket #1494)
Oct. 17, 2013: by Thomas Beutlich, ITI GmbH
Added support of 2D tables that actually degrade to 1D tables
(ticket #1307)
Sep. 05, 2013: by Thomas Beutlich, ITI GmbH
Fixed ANSI-C compliance (ticket #1263)
Fixed reading table files with Windows line endings on Linux
(ticket #1264)
Apr. 09, 2013: by Thomas Beutlich, ITI GmbH
Implemented a first version
*/
#include "ModelicaStandardTables.h"
#include "ModelicaIO.h"
#include "ModelicaUtilities.h"
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
#include "stdint_wrap.h"
#define HASH_NO_STDINT 1
#define uthash_strlen(s) key_strlen(s)
#define HASH_NONFATAL_OOM 1
#include "uthash.h"
#include "gconstructor.h"
#endif
#include <float.h>
#include <math.h>
#include <string.h>
#if !defined(NO_FILE_SYSTEM)
/* The standard way to detect POSIX is to check _POSIX_VERSION,
* which is defined in <unistd.h>
*/
#if defined(__unix__) || defined(__linux__) || defined(__APPLE_CC__)
#include <unistd.h>
#endif
#if !defined(_POSIX_) && defined(_POSIX_VERSION)
#define _POSIX_ 1
#endif
#endif
/* ----- Interface enumerations ----- */
enum Smoothness {
LINEAR_SEGMENTS = 1,
CONTINUOUS_DERIVATIVE,
CONSTANT_SEGMENTS,
FRITSCH_BUTLAND_MONOTONE_C1,
STEFFEN_MONOTONE_C1,
MAKIMA_C1,
AKIMA_C1 = CONTINUOUS_DERIVATIVE
};
enum Extrapolation {
HOLD_LAST_POINT = 1,
LAST_TWO_POINTS,
PERIODIC,
NO_EXTRAPOLATION
};
enum TimeEvents {
UNDEFINED = 0,
ALWAYS,
AT_DISCONT,
NO_TIMEEVENTS
};
/* ----- Internal enumerations ----- */
enum PointInterval {
LEFT = -1,
IN_TABLE = 0,
RIGHT = 1
};
enum TableSource {
TABLESOURCE_MODEL = 1,
TABLESOURCE_FILE,
TABLESOURCE_FUNCTION,
TABLESOURCE_FUNCTION_TRANSPOSE
};
enum CleanUp {
NO_CLEANUP = 0,
DO_CLEANUP
};
/* ----- Internal table memory ----- */
/* 3 (of 4) 1D cubic Hermite spline coefficients (per interval) */
typedef double CubicHermite1D[3];
/* 15 (of 16) 2D cubic Hermite spline coefficients (per grid) */
typedef double CubicHermite2D[15];
/* Left and right interval indices (per interval) */
typedef size_t Interval[2];
typedef struct CombiTimeTable {
char* key; /* Key consisting of concatenated names of file and table */
double* table; /* Table values */
size_t nRow; /* Number of rows of table */
size_t nCol; /* Number of columns of table */
size_t last; /* Last accessed row index of table */
enum Smoothness smoothness; /* Smoothness kind */
enum Extrapolation extrapolation; /* Extrapolation kind */
enum TableSource source; /* Source kind */
enum TimeEvents timeEvents; /* Kind of time event handling */
int* cols; /* Columns of table to be interpolated */
size_t nCols; /* Number of columns of table to be interpolated */
double startTime; /* Start time of inter-/extrapolation */
double shiftTime; /* Shift time of first table column */
CubicHermite1D* spline; /* Pre-calculated cubic Hermite spline coefficients,
only used if smoothness is AKIMA_C1 or MAKIMA_C1 or
FRITSCH_BUTLAND_MONOTONE_C1 or STEFFEN_MONOTONE_C1 */
size_t nEvent; /* Time event counter, discrete */
double preNextTimeEvent; /* Time of previous time event, discrete */
double preNextTimeEventCalled; /* Time of previous call of
ModelicaStandardTables_CombiTimeTable_nextTimeEvent, discrete */
size_t maxEvents; /* Maximum number of time events (per period/cycle) */
size_t eventInterval; /* Event interval marker, discrete,
In case of periodic extrapolation this is the current event interval,
otherwise it is the next event interval. */
double tOffset; /* Time offset, calculated by floor function, discrete,
only used if extrapolation is PERIODIC */
Interval* intervals; /* Event interval indices */
} CombiTimeTable;
typedef struct CombiTable1D {
char* key; /* Key consisting of concatenated names of file and table */
double* table; /* Table values */
size_t nRow; /* Number of rows of table */
size_t nCol; /* Number of columns of table */
size_t last; /* Last accessed row index of table */
enum Smoothness smoothness; /* Smoothness kind */
enum Extrapolation extrapolation; /* Extrapolation kind */
enum TableSource source; /* Source kind */
int* cols; /* Columns of table to be interpolated */
size_t nCols; /* Number of columns of table to be interpolated */
CubicHermite1D* spline; /* Pre-calculated cubic Hermite spline coefficients,
only used if smoothness is AKIMA_C1 or MAKIMA_C1 or
FRITSCH_BUTLAND_MONOTONE_C1 or STEFFEN_MONOTONE_C1 */
} CombiTable1D;
typedef struct CombiTable2D {
char* key; /* Key consisting of concatenated names of file and table */
double* table; /* Table values */
size_t nRow; /* Number of rows of table */
size_t nCol; /* Number of columns of table */
size_t last1; /* Last accessed row index of table */
size_t last2; /* Last accessed column index of table */
enum Smoothness smoothness; /* Smoothness kind */
enum Extrapolation extrapolation; /* Extrapolation kind */
enum TableSource source; /* Source kind */
CubicHermite2D* spline; /* Pre-calculated cubic Hermite spline coefficients,
only used if smoothness is AKIMA_C1 */
} CombiTable2D;
/* ----- Internal constants ----- */
#if !defined(_EPSILON)
#define _EPSILON (1e-10)
#endif
#if !defined(MAX_TABLE_DIMENSIONS)
#define MAX_TABLE_DIMENSIONS (3)
#endif
/* ----- Internal shortcuts ----- */
#define IDX(i, j, n) ((i)*(n) + (j))
#define TABLE(i, j) table[IDX(i, j, nCol)]
#define TABLE_ROW0(j) table[j]
#define TABLE_COL0(i) table[(i)*nCol]
#define LINEAR(u, u0, u1, y0, y1) \
do {\
y = (y0) + ((y1) - (y0))*((u) - (u0))/((u1) - (u0)); \
} while(0)
/*
LINEAR(u0, ...) -> y0
LINEAR(u1, ...) -> y1
*/
#define LINEAR_SLOPE(y0, dy_du, du) \
do {\
y = (y0) + (dy_du)*(du); \
} while(0)
#define BILINEAR(u1, u2) \
do {\
const double u10 = TABLE_COL0(last1 + 1); \
const double u11 = TABLE_COL0(last1 + 2); \
const double u20 = TABLE_ROW0(last2 + 1); \
const double u21 = TABLE_ROW0(last2 + 2); \
const double y00 = TABLE(last1 + 1, last2 + 1); \
const double y01 = TABLE(last1 + 1, last2 + 2); \
const double y10 = TABLE(last1 + 2, last2 + 1); \
const double y11 = TABLE(last1 + 2, last2 + 2); \
const double tmp = ((u2) - u20)/(u20 - u21); \
y = y00 + tmp*(y00 - y01) + ((u1) - u10)/(u10 - u11)* \
((1 + tmp)*(y00 - y10) + tmp*(y11 - y01)); \
} while(0)
/*
BILINEAR(u10, u20, ...) -> y00
BILINEAR(u10, u21, ...) -> y01
BILINEAR(u11, u20, ...) -> y10
BILINEAR(u11, u21, ...) -> y11
*/
#define BILINEAR_DER(u1, u2) \
do {\
const double u10 = TABLE_COL0(last1 + 1); \
const double u11 = TABLE_COL0(last1 + 2); \
const double u20 = TABLE_ROW0(last2 + 1); \
const double u21 = TABLE_ROW0(last2 + 2); \
const double y00 = TABLE(last1 + 1, last2 + 1); \
const double y01 = TABLE(last1 + 1, last2 + 2); \
const double y10 = TABLE(last1 + 2, last2 + 1); \
const double y11 = TABLE(last1 + 2, last2 + 2); \
der_y = der_u1*(u21*(y10 - y00) + u20*(y01 - y11) + \
(u2)*(y00 - y01 - y10 + y11)); \
der_y += der_u2*(u11*(y01 - y00) + u10*(y10 - y11) + \
(u1)*(y00 - y01 - y10 + y11)); \
der_y /= (u10 - u11); \
der_y /= (u20 - u21); \
} while(0)
#define BILINEAR_DER2(u1, u2) \
do {\
const double u10 = TABLE_COL0(last1 + 1); \
const double u11 = TABLE_COL0(last1 + 2); \
const double u20 = TABLE_ROW0(last2 + 1); \
const double u21 = TABLE_ROW0(last2 + 2); \
const double y00 = TABLE(last1 + 1, last2 + 1); \
const double y01 = TABLE(last1 + 1, last2 + 2); \
const double y10 = TABLE(last1 + 2, last2 + 1); \
const double y11 = TABLE(last1 + 2, last2 + 2); \
der2_y = der2_u1*(u21*(y10 - y00) + u20*(y01 - y11) + \
(u2)*(y00 - y01 - y10 + y11)); \
der2_y += der2_u2*(u11*(y01 - y00) + u10*(y10 - y11) + \
(u1)*(y00 - y01 - y10 + y11)); \
der2_y += 2*der_u1*der_u2*(y00 - y01 - y10 + y11); \
der2_y /= (u10 - u11); \
der2_y /= (u20 - u21); \
} while(0)
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
typedef struct TableShare {
char* key; /* Key consisting of concatenated names of file and table */
size_t refCount; /* Reference counter */
size_t nRow; /* Number of rows of table */
size_t nCol; /* Number of columns of table */
double* table; /* Table values */
UT_hash_handle hh; /* Hashable structure */
} TableShare;
/* ----- Static variables ----- */
static TableShare* tableShare = NULL;
#if defined(_POSIX_) && !defined(NO_MUTEX)
#include <pthread.h>
#if defined(G_HAS_CONSTRUCTORS)
static pthread_mutex_t m;
G_DEFINE_CONSTRUCTOR(initializeMutex)
static void initializeMutex(void) {
if (pthread_mutex_init(&m, NULL) != 0) {
ModelicaError("Initialization of mutex failed\n");
}
}
G_DEFINE_DESTRUCTOR(destroyMutex)
static void destroyMutex(void) {
if (pthread_mutex_destroy(&m) != 0) {
ModelicaError("Destruction of mutex failed\n");
}
}
#else
static pthread_mutex_t m = PTHREAD_MUTEX_INITIALIZER;
#endif
#define MUTEX_LOCK() pthread_mutex_lock(&m)
#define MUTEX_UNLOCK() pthread_mutex_unlock(&m)
#elif defined(_WIN32) && defined(G_HAS_CONSTRUCTORS)
#if !defined(WIN32_LEAN_AND_MEAN)
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
static CRITICAL_SECTION cs;
#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA
#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(ModelicaStandardTables_initializeCS)
#endif
G_DEFINE_CONSTRUCTOR(ModelicaStandardTables_initializeCS)
static void ModelicaStandardTables_initializeCS(void) {
InitializeCriticalSection(&cs);
}
#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA
#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(ModelicaStandardTables_deleteCS)
#endif
G_DEFINE_DESTRUCTOR(ModelicaStandardTables_deleteCS)
static void ModelicaStandardTables_deleteCS(void) {
DeleteCriticalSection(&cs);
}
#define MUTEX_LOCK() EnterCriticalSection(&cs)
#define MUTEX_UNLOCK() LeaveCriticalSection(&cs)
#else
#define MUTEX_LOCK()
#define MUTEX_UNLOCK()
#endif
#endif
/* ----- Function declarations ----- */
extern int usertab(char* tableName, int nipo, int dim[], int* colWise,
double** table);
/* Define tables by statically storing them in function usertab.
This function can be adapted by the user to his/her needs.
-> tableName: Name of table
-> nipo : = 0: time-table required (time interpolation)
= 1: 1D-table required
= 2: 2D-table required
<- dim: Actual values of dimensions
<- colWise: = 0: table stored row-wise (row_1, row_2, ..., row_n)
= 1: table stored column-wise (column_1, column_2, ...)
<- table: Pointer to vector containing a matrix with dimensions "dim"
<- RETURN: = 0: No error
= 1: An error occurred. An error message is printed from usertab.
*/
static int isNearlyEqual(double x, double y);
/* Compare two floating-point numbers by threshold _EPSILON */
static size_t findRowIndex(_In_ const double* table, size_t nRow, size_t nCol,
size_t last, double x) MODELICA_NONNULLATTR;
/* Find the row index i using binary search such that
* i + 1 < nRow
* table[i*nCol] <= x
* table[(i + 1)*nCol] > x for i + 2 < nRow
*/
static size_t findRowIndex2(_In_ const double* table, size_t nRow, size_t nCol,
size_t last, double x, double dx) MODELICA_NONNULLATTR;
/* Using dx as tie-breaker if table[i*nCol] == x to treat x as x+dx*eps */
static size_t findColIndex(_In_ const double* table, size_t nCol, size_t last,
double x) MODELICA_NONNULLATTR;
/* Same as findRowIndex but works on columns */
static size_t findColIndex2(_In_ const double* table, size_t nCol, size_t last,
double x, double dx) MODELICA_NONNULLATTR;
/* Same as findRowIndex2 but works on columns */
static int isLess(double x, double dx, double val);
/* Check, whether x is less than val, also using dx as tie-breaker */
static int isValidName(_In_z_ const char* name) MODELICA_NONNULLATTR;
/* Check, whether a file or table name is valid */
static int isValidCombiTimeTable(CombiTimeTable* tableID,
_In_z_ const char* tableName, enum CleanUp cleanUp);
/* Check, whether a CombiTimeTable is well parameterized */
static int isValidCombiTable1D(CombiTable1D* tableID,
_In_z_ const char* tableName, enum CleanUp cleanUp);
/* Check, whether a CombiTable1D is well parameterized */
static int isValidCombiTable2D(CombiTable2D* tableID,
_In_z_ const char* tableName, enum CleanUp cleanUp);
/* Check, whether a CombiTable2D is well parameterized */
static enum TableSource getTableSource(_In_z_ const char* fileName,
_In_z_ const char* tableName) MODELICA_NONNULLATTR;
/* Determine table source (file, model or "usertab" function) from table
and file names
*/
static void transpose(_Inout_ double* table, size_t nRow, size_t nCol) MODELICA_NONNULLATTR;
/* Cycle-based in-place array transposition */
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
static size_t key_strlen(_In_z_ const char *s);
/* Special strlen for key consisting of concatenated names of file and table */
#endif
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
#define READ_RESULT TableShare*
#else
#define READ_RESULT double*
#endif
static READ_RESULT readTable(_In_z_ const char* fileName, _In_z_ const char* tableName,
_Inout_ size_t* nRow, _Inout_ size_t* nCol, int verbose,
int force, _In_z_ const char* delimiter,
int nHeaderLines) MODELICA_NONNULLATTR;
/* Read a table from a text or MATLAB MAT-file
<- RETURN: Pointer to TableShare structure or
pointer to array (row-wise storage) of table values
*/
static CubicHermite1D* akimaSpline1DInit(_In_ const double* table, size_t nRow,
size_t nCol, _In_ const int* cols,
size_t nCols) MODELICA_NONNULLATTR;
/* Calculate the coefficients for univariate cubic Hermite spline
interpolation with the Akima slope approximation
<- RETURN: Pointer to array of coefficients
*/
static CubicHermite1D* makimaSpline1DInit(_In_ const double* table, size_t nRow,
size_t nCol, _In_ const int* cols,
size_t nCols) MODELICA_NONNULLATTR;
/* Calculate the coefficients for univariate cubic Hermite spline
interpolation with the modified Akima slope approximation
<- RETURN: Pointer to array of coefficients
*/
static CubicHermite1D* fritschButlandSpline1DInit(_In_ const double* table,
size_t nRow, size_t nCol,
_In_ const int* cols,
size_t nCols) MODELICA_NONNULLATTR;
/* Calculate the coefficients for univariate cubic Hermite spline
interpolation with the Fritsch-Butland slope approximation
<- RETURN: Pointer to array of coefficients
*/
static CubicHermite1D* steffenSpline1DInit(_In_ const double* table,
size_t nRow, size_t nCol,
_In_ const int* cols,
size_t nCols) MODELICA_NONNULLATTR;
/* Calculate the coefficients for univariate cubic Hermite spline
interpolation with the Steffen slope approximation
<- RETURN: Pointer to array of coefficients
*/
static void spline1DClose(CubicHermite1D** spline);
/* Free allocated memory of the 1D cubic Hermite spline coefficients */
static CubicHermite2D* spline2DInit(_In_ const double* table, size_t nRow,
size_t nCol) MODELICA_NONNULLATTR;
/* Calculate the coefficients for bivariate cubic Hermite spline
interpolation with the Akima algorithm
<- RETURN: Pointer to array of coefficients
*/
static void spline2DClose(CubicHermite2D** spline);
/* Free allocated memory of the 2D cubic Hermite spline coefficients */
/* ----- Interface functions ----- */
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wtautological-compare"
#endif
void* ModelicaStandardTables_CombiTimeTable_init(_In_z_ const char* tableName,
_In_z_ const char* fileName,
_In_ double* table, size_t nRow,
size_t nColumn,
double startTime,
_In_ int* columns,
size_t nCols, int smoothness,
int extrapolation) {
return ModelicaStandardTables_CombiTimeTable_init2(fileName,
tableName, table, nRow, nColumn, startTime, columns, nCols, smoothness,
extrapolation, startTime, ALWAYS, 1 /* verbose */);
}
void* ModelicaStandardTables_CombiTimeTable_init2(_In_z_ const char* fileName,
_In_z_ const char* tableName,
_In_ double* table, size_t nRow,
size_t nColumn,
double startTime,
_In_ int* columns,
size_t nCols, int smoothness,
int extrapolation,
double shiftTime,
int timeEvents,
int verbose) {
return ModelicaStandardTables_CombiTimeTable_init3(fileName,
tableName, table, nRow, nColumn, startTime, columns, nCols, smoothness,
extrapolation, shiftTime, timeEvents, verbose, ",", 0);
}
void* ModelicaStandardTables_CombiTimeTable_init3(_In_z_ const char* fileName,
_In_z_ const char* tableName,
_In_ double* table, size_t nRow,
size_t nColumn,
double startTime,
_In_ int* columns,
size_t nCols, int smoothness,
int extrapolation,
double shiftTime,
int timeEvents,
int verbose,
_In_z_ const char* delimiter,
int nHeaderLines) {
CombiTimeTable* tableID;
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
TableShare* file = NULL;
char* keyFile = NULL;
#endif
double* tableFile = NULL;
size_t nRowFile = 0;
size_t nColFile = 0;
enum TableSource source = getTableSource(fileName, tableName);
/* Read table from file before any other heap allocation */
if (TABLESOURCE_FILE == source) {
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
file = readTable(fileName, tableName, &nRowFile, &nColFile, verbose, 0, delimiter, nHeaderLines);
if (NULL != file) {
keyFile = file->key;
tableFile = file->table;
}
else {
return NULL;
}
#else
tableFile = readTable(fileName, tableName, &nRowFile, &nColFile, verbose, 0, delimiter, nHeaderLines);
if (NULL == tableFile) {
return NULL;
}
#endif
}
tableID = (CombiTimeTable*)calloc(1, sizeof(CombiTimeTable));
if (NULL == tableID) {
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
if (NULL != file) {
MUTEX_LOCK();
if (--file->refCount == 0) {
ModelicaIO_freeRealTable(file->table);
free(file->key);
HASH_DEL(tableShare, file);
free(file);
}
MUTEX_UNLOCK();
}
#else
if (NULL != tableFile) {
free(tableFile);
}
#endif
ModelicaError("Memory allocation error\n");
return NULL;
}
tableID->smoothness = (enum Smoothness)smoothness;
tableID->extrapolation = (enum Extrapolation)extrapolation;
tableID->timeEvents = (enum TimeEvents)timeEvents;
tableID->nCols = nCols;
tableID->startTime = startTime;
tableID->shiftTime = shiftTime;
tableID->preNextTimeEvent = -DBL_MAX;
tableID->preNextTimeEventCalled = -DBL_MAX;
tableID->source = source;
switch (tableID->source) {
case TABLESOURCE_FILE:
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
tableID->key = keyFile;
#else
{
size_t lenFileName = strlen(fileName);
tableID->key = (char*)malloc((lenFileName + strlen(tableName) + 2)*sizeof(char));
if (NULL != tableID->key) {
strcpy(tableID->key, fileName);
strcpy(tableID->key + lenFileName + 1, tableName);
}
}
#endif
tableID->nRow = nRowFile;
tableID->nCol = nColFile;
tableID->table = tableFile;
break;
case TABLESOURCE_MODEL:
tableID->nRow = nRow;
tableID->nCol = nColumn;
#if defined(NO_TABLE_COPY)
tableID->table = table;
#else
tableID->table = (double*)malloc(nRow*nColumn*sizeof(double));
if (NULL != tableID->table) {
memcpy(tableID->table, table, nRow*nColumn*sizeof(double));
}
else {
ModelicaStandardTables_CombiTimeTable_close(tableID);
ModelicaError("Memory allocation error\n");
return NULL;
}
#endif
break;
case TABLESOURCE_FUNCTION: {
int colWise;
int dim[MAX_TABLE_DIMENSIONS];
if (usertab((char*)tableName, 0 /* Time-interpolation */, dim,
&colWise, &tableID->table) == 0) {
if (0 == colWise) {
tableID->nRow = (size_t)dim[0];
tableID->nCol = (size_t)dim[1];
}
else {
/* Need to transpose */
double* tableT = (double*)malloc(
(size_t)dim[0]*(size_t)dim[1]*sizeof(double));
if (NULL != tableT) {
memcpy(tableT, tableID->table,
(size_t)dim[0]*(size_t)dim[1]*sizeof(double));
tableID->table = tableT;
tableID->nRow = (size_t)dim[1];
tableID->nCol = (size_t)dim[0];
tableID->source = TABLESOURCE_FUNCTION_TRANSPOSE;
transpose(tableID->table, tableID->nRow, tableID->nCol);
}
else {
ModelicaStandardTables_CombiTimeTable_close(tableID);
ModelicaError("Memory allocation error\n");
return NULL;
}
}
}
break;
}
case TABLESOURCE_FUNCTION_TRANSPOSE:
/* Should not be possible to get here */
break;
default:
ModelicaStandardTables_CombiTimeTable_close(tableID);
ModelicaError("Table source error\n");
return NULL;
}
if (nCols > 0) {
tableID->cols = (int*)malloc(tableID->nCols*sizeof(int));
if (NULL != tableID->cols) {
memcpy(tableID->cols, columns, tableID->nCols*sizeof(int));
}
else {
ModelicaStandardTables_CombiTimeTable_close(tableID);
ModelicaError("Memory allocation error\n");
return NULL;
}
}
if (isValidCombiTimeTable(tableID, tableName, DO_CLEANUP) == 0) {
return NULL;
}
if (tableID->nRow <= 2) {
if (tableID->smoothness == AKIMA_C1 ||
tableID->smoothness == MAKIMA_C1 ||
tableID->smoothness == FRITSCH_BUTLAND_MONOTONE_C1 ||
tableID->smoothness == STEFFEN_MONOTONE_C1) {
tableID->smoothness = LINEAR_SEGMENTS;
}
}
/* Initialization of the cubic Hermite spline coefficients */
if (tableID->smoothness == AKIMA_C1) {
tableID->spline = akimaSpline1DInit(
(const double*)tableID->table, tableID->nRow,
tableID->nCol, (const int*)tableID->cols, tableID->nCols);
}
else if (tableID->smoothness == MAKIMA_C1) {
tableID->spline = makimaSpline1DInit(
(const double*)tableID->table, tableID->nRow,
tableID->nCol, (const int*)tableID->cols, tableID->nCols);
}
else if (tableID->smoothness == FRITSCH_BUTLAND_MONOTONE_C1) {
tableID->spline = fritschButlandSpline1DInit(
(const double*)tableID->table, tableID->nRow,
tableID->nCol, (const int*)tableID->cols, tableID->nCols);
}
else if (tableID->smoothness == STEFFEN_MONOTONE_C1) {
tableID->spline = steffenSpline1DInit(
(const double*)tableID->table, tableID->nRow,
tableID->nCol, (const int*)tableID->cols, tableID->nCols);
}
if (tableID->smoothness == AKIMA_C1 ||
tableID->smoothness == MAKIMA_C1 ||
tableID->smoothness == FRITSCH_BUTLAND_MONOTONE_C1 ||
tableID->smoothness == STEFFEN_MONOTONE_C1) {
if (NULL == tableID->spline) {
ModelicaStandardTables_CombiTimeTable_close(tableID);
ModelicaError("Memory allocation error\n");
return NULL;
}
}
return (void*)tableID;
}
void ModelicaStandardTables_CombiTimeTable_close(void* _tableID) {
CombiTimeTable* tableID = (CombiTimeTable*)_tableID;
if (NULL == tableID) {
return;
}
if (NULL != tableID->table && tableID->source == TABLESOURCE_FILE) {
#if defined(TABLE_SHARE) && !defined(NO_FILE_SYSTEM)
if (NULL != tableID->key) {
TableShare* file;
MUTEX_LOCK();
HASH_FIND_STR(tableShare, tableID->key, file);
if (NULL != file) {
/* Share hit */
if (--file->refCount == 0) {
ModelicaIO_freeRealTable(file->table);
free(file->key);
HASH_DEL(tableShare, file);
free(file);
}
}
MUTEX_UNLOCK();
}
else {
/* Should not be possible to get here */
free(tableID->table);
}
#else
if (NULL != tableID->key) {
free(tableID->key);
}
free(tableID->table);
#endif
}
else if (NULL != tableID->table && (
#if !defined(NO_TABLE_COPY)
tableID->source == TABLESOURCE_MODEL ||
#endif
tableID->source == TABLESOURCE_FUNCTION_TRANSPOSE)) {
free(tableID->table);
}
if (tableID->nCols > 0 && NULL != tableID->cols) {
free(tableID->cols);
}
if (NULL != tableID->intervals) {
free(tableID->intervals);
}
spline1DClose(&tableID->spline);
free(tableID);
}
double ModelicaStandardTables_CombiTimeTable_getValue(void* _tableID, int iCol,
double t, double nextTimeEvent,
double preNextTimeEvent) {
double y = 0.;
CombiTimeTable* tableID = (CombiTimeTable*)_tableID;
if (NULL != tableID && NULL != tableID->table && NULL != tableID->cols &&
t >= tableID->startTime) {
if (nextTimeEvent < DBL_MAX && nextTimeEvent == preNextTimeEvent &&
tableID->startTime >= nextTimeEvent) {
/* Before start time event iteration: Return zero */
return y;
}
else {
const double* table = tableID->table;
const size_t nRow = tableID->nRow;
const size_t nCol = tableID->nCol;
const size_t col = (size_t)tableID->cols[iCol - 1] - 1;
if (nRow == 1) {
/* Single row */
y = TABLE_ROW0(col);
}
else {
enum PointInterval extrapolate = IN_TABLE;
const double tMin = TABLE_ROW0(0);
const double tMax = TABLE_COL0(nRow - 1);
size_t last;
/* Shift time */
const double tOld = t;
t -= tableID->shiftTime;
/* Periodic extrapolation */
if (tableID->extrapolation == PERIODIC) {
const double T = tMax - tMin;
/* Event handling for periodic extrapolation */
if (nextTimeEvent == preNextTimeEvent &&
tOld >= nextTimeEvent) {
/* Before event iteration: Return previous
interval value */
size_t i;
if (tableID->smoothness == CONSTANT_SEGMENTS) {
i = tableID->intervals[
tableID->eventInterval - 1][0];
}
else {
i = tableID->intervals[
tableID->eventInterval - 1][1];
}
y = TABLE(i, col);
return y;
}
else if (nextTimeEvent > preNextTimeEvent &&
tOld >= preNextTimeEvent &&
tableID->startTime < preNextTimeEvent) {
/* In regular (= not start time) event iteration:
Return left interval value */
size_t i = tableID->intervals[
tableID->eventInterval - 1][0];
y = TABLE(i, col);
return y;
}
else {
/* After event iteration */
const size_t i0 = tableID->intervals[
tableID->eventInterval - 1][0];
const size_t i1 = tableID->intervals[
tableID->eventInterval - 1][1];
t -= tableID->tOffset;
if (t < tMin) {
do {
t += T;
} while (t < tMin);
}
else if (t > tMax) {
do {
t -= T;
} while (t > tMax);
}
last = findRowIndex(table, nRow, nCol, tableID->last, t);
tableID->last = last;
/* Event interval correction */
if (last < i0) {
t = TABLE_COL0(i0);
}
if (last >= i1) {
if (tableID->eventInterval == 1) {
t = TABLE_COL0(i0);
}