Skip to content

Commit 3cd29cc

Browse files
schmoelderschmoelder
committed
fixup! Update C-API
1 parent d8c24d8 commit 3cd29cc

File tree

1 file changed

+113
-34
lines changed

1 file changed

+113
-34
lines changed

‎cadet/cadet_dll.py

+113-34
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
# Common types for ctypes function signatures
1515
CadetDriver = ctypes.c_void_p
1616
array_double = ctypes.POINTER(ctypes.POINTER(ctypes.c_double))
17+
point_bool = ctypes.POINTER(ctypes.c_bool)
1718
point_int = ctypes.POINTER(ctypes.c_int)
19+
point_double = ctypes.POINTER(ctypes.c_double)
1820

1921
# Values of cdtResult
2022
c_cadet_result = ctypes.c_int
@@ -41,43 +43,47 @@ class CADETAPIV010000_DATA:
4143
# API function signatures
4244
# Note, order is important, it has to match the cdtAPIv010000 struct of the C-API
4345
signatures = {}
46+
47+
signatures['getFileFormat'] = ('return', 'fileFormat')
48+
4449
signatures['createDriver'] = ('drv',)
4550
signatures['deleteDriver'] = (None, 'drv')
4651
signatures['runSimulation'] = ('return', 'drv', 'parameterProvider')
4752

53+
signatures['getNumUnitOp'] = ('return', 'drv', 'nUnits')
4854
signatures['getNumParTypes'] = ('return', 'drv', 'unitOpId', 'nParTypes')
4955
signatures['getNumSensitivities'] = ('return', 'drv', 'nSens')
5056

5157
signatures['getSolutionInlet'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nPort', 'nComp')
5258
signatures['getSolutionOutlet'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nPort', 'nComp')
53-
signatures['getSolutionBulk'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp')
54-
signatures['getSolutionParticle'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp')
55-
signatures['getSolutionSolid'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound')
56-
signatures['getSolutionFlux'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp')
59+
signatures['getSolutionBulk'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp', 'keepAxialSingletonDimension')
60+
signatures['getSolutionParticle'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
61+
signatures['getSolutionSolid'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
62+
signatures['getSolutionFlux'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp', 'keepAxialSingletonDimension')
5763
signatures['getSolutionVolume'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime')
5864

5965
signatures['getSolutionDerivativeInlet'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nPort', 'nComp')
6066
signatures['getSolutionDerivativeOutlet'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nPort', 'nComp')
61-
signatures['getSolutionDerivativeBulk'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp')
62-
signatures['getSolutionDerivativeParticle'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp')
63-
signatures['getSolutionDerivativeSolid'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound')
64-
signatures['getSolutionDerivativeFlux'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp')
67+
signatures['getSolutionDerivativeBulk'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp', 'keepAxialSingletonDimension')
68+
signatures['getSolutionDerivativeParticle'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
69+
signatures['getSolutionDerivativeSolid'] = ('return', 'drv', 'unitOpId', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
70+
signatures['getSolutionDerivativeFlux'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp', 'keepAxialSingletonDimension')
6571
signatures['getSolutionDerivativeVolume'] = ('return', 'drv', 'unitOpId', 'time', 'data', 'nTime')
6672

6773
signatures['getSensitivityInlet'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nPort', 'nComp')
6874
signatures['getSensitivityOutlet'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nPort', 'nComp')
69-
signatures['getSensitivityBulk'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp')
70-
signatures['getSensitivityParticle'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp')
71-
signatures['getSensitivitySolid'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound')
72-
signatures['getSensitivityFlux'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp')
75+
signatures['getSensitivityBulk'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp', 'keepAxialSingletonDimension')
76+
signatures['getSensitivityParticle'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
77+
signatures['getSensitivitySolid'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
78+
signatures['getSensitivityFlux'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp', 'keepAxialSingletonDimension')
7379
signatures['getSensitivityVolume'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime')
7480

7581
signatures['getSensitivityDerivativeInlet'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nPort', 'nComp')
7682
signatures['getSensitivityDerivativeOutlet'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nPort', 'nComp')
77-
signatures['getSensitivityDerivativeBulk'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp')
78-
signatures['getSensitivityDerivativeParticle'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp')
79-
signatures['getSensitivityDerivativeSolid'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound')
80-
signatures['getSensitivityDerivativeFlux'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp')
83+
signatures['getSensitivityDerivativeBulk'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nComp', 'keepAxialSingletonDimension')
84+
signatures['getSensitivityDerivativeParticle'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nComp', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
85+
signatures['getSensitivityDerivativeSolid'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'parType', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParShells', 'nBound', 'keepAxialSingletonDimension', 'keepParticleSingletonDimension')
86+
signatures['getSensitivityDerivativeFlux'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime', 'nAxialCells', 'nRadialCells', 'nParTypes', 'nComp', 'keepAxialSingletonDimension')
8187
signatures['getSensitivityDerivativeVolume'] = ('return', 'drv', 'unitOpId', 'sensIdx', 'time', 'data', 'nTime')
8288

8389
signatures['getLastState'] = ('return', 'drv', 'state', 'nStates')
@@ -92,19 +98,18 @@ class CADETAPIV010000_DATA:
9298
signatures['getPrimaryCoordinates'] = ('return', 'drv', 'unitOpId', 'coords', 'nCoords')
9399
signatures['getSecondaryCoordinates'] = ('return', 'drv', 'unitOpId', 'coords', 'nCoords')
94100
signatures['getParticleCoordinates'] = ('return', 'drv', 'unitOpId', 'parType', 'coords', 'nCoords')
95-
96101
signatures['getSolutionTimes'] = ('return', 'drv', 'time', 'nTime')
97102

103+
signatures['getTimeSim'] = ('return', 'drv', 'timeSim')
104+
98105
# Mappings for common ctypes parameters
99106
lookup_prototype = {
107+
None: None,
100108
'return': c_cadet_result,
109+
'fileFormat': point_int,
101110
'drv': CadetDriver,
102-
'unitOpId': ctypes.c_int,
103-
'sensIdx': ctypes.c_int,
104-
'parType': ctypes.c_int,
105-
'time': array_double,
106-
'data': array_double,
107-
'coords': array_double,
111+
'parameterProvider': ctypes.POINTER(cadet_dll_parameterprovider.PARAMETERPROVIDER),
112+
'nUnits': point_int,
108113
'nTime': point_int,
109114
'nCoords': point_int,
110115
'nPort': point_int,
@@ -115,16 +120,24 @@ class CADETAPIV010000_DATA:
115120
'nParShells': point_int,
116121
'nComp': point_int,
117122
'nBound': point_int,
118-
'state': array_double,
119123
'nStates': point_int,
120-
None: None,
121-
'parameterProvider': ctypes.POINTER(cadet_dll_parameterprovider.PARAMETERPROVIDER),
124+
'unitOpId': ctypes.c_int,
125+
'sensIdx': ctypes.c_int,
126+
'parType': ctypes.c_int,
127+
'time': array_double,
128+
'data': array_double,
129+
'state': array_double,
130+
'coords': array_double,
131+
'keepAxialSingletonDimension': point_bool,
132+
'keepParticleSingletonDimension': point_bool,
133+
'timeSim': point_double,
122134
}
123135

124136
lookup_output_argument_type = {
125-
'time': ctypes.POINTER(ctypes.c_double),
137+
'fileFormat': ctypes.c_int,
138+
'nUnits': ctypes.c_int,
126139
'nTime': ctypes.c_int,
127-
'data': ctypes.POINTER(ctypes.c_double),
140+
'nCoords': ctypes.c_int,
128141
'nPort': ctypes.c_int,
129142
'nAxialCells': ctypes.c_int,
130143
'nRadialCells': ctypes.c_int,
@@ -133,10 +146,14 @@ class CADETAPIV010000_DATA:
133146
'nParShells': ctypes.c_int,
134147
'nComp': ctypes.c_int,
135148
'nBound': ctypes.c_int,
136-
'state': ctypes.POINTER(ctypes.c_double),
137149
'nStates': ctypes.c_int,
150+
'time': ctypes.POINTER(ctypes.c_double),
151+
'data': ctypes.POINTER(ctypes.c_double),
152+
'state': ctypes.POINTER(ctypes.c_double),
138153
'coords': ctypes.POINTER(ctypes.c_double),
139-
'nCoords': ctypes.c_int,
154+
'keepAxialSingletonDimension': ctypes.c_bool,
155+
'keepParticleSingletonDimension': ctypes.c_bool,
156+
'timeSim': ctypes.c_double,
140157
}
141158

142159

@@ -299,6 +316,7 @@ def _process_data(
299316
"""
300317
shape = []
301318
dims = []
319+
drop_indices = []
302320

303321
# Ordering of multi-dimensional arrays, all possible dimensions:
304322
# bulk: 'nTime', ('nAxialCells',) ('nRadialCells' / 'nPorts',) 'nComp'
@@ -324,10 +342,19 @@ def _process_data(
324342
return
325343

326344
if 'data' in call_outputs:
345+
if 'nAxialCells' in dims:
346+
nAxialCells = call_outputs['nAxialCells'].value
347+
keep_axial_singleton_dim = call_outputs['keepAxialSingletonDimension'].value
348+
if nAxialCells == 1 and not keep_axial_singleton_dim:
349+
drop_indices.append(dims.index('nAxialCells'))
350+
327351
if 'nParShells' in dims:
328352
nParShells = call_outputs['nParShells'].value
329-
if nParShells == 1:
330-
shape.pop(dims.index('nParShells'))
353+
keep_particle_singleton_dim = call_outputs['keepParticleSingletonDimension'].value
354+
if nParShells == 1 and not keep_particle_singleton_dim:
355+
drop_indices.append(dims.index('nParShells'))
356+
357+
shape = numpy.delete(shape, drop_indices)
331358

332359
data = numpy.ctypeslib.as_array(call_outputs['data'], shape=shape)
333360
if own_data:
@@ -400,6 +427,38 @@ def _load_and_process_array(
400427

401428
return self._process_array(call_outputs, data_key, len_key, own_data)
402429

430+
def file_format(
431+
self,
432+
own_data: bool = True,
433+
) -> float:
434+
"""
435+
Load the file format used for the simulation config.
436+
437+
Parameters
438+
----------
439+
own_data : bool, optional
440+
Whether to copy the data (default is True).
441+
442+
Returns
443+
-------
444+
int
445+
The file format.
446+
"""
447+
call_outputs = self._load_data('getFileFormat')
448+
return int(call_outputs['fileFormat'].value)
449+
450+
def nunits(self) -> int:
451+
"""
452+
Get the number of unit operations in the system.
453+
454+
Returns
455+
-------
456+
int
457+
The number of unit operations in the system.
458+
"""
459+
call_outputs = self._load_data('getNumUnitOp')
460+
return int(call_outputs['nUnits'].value)
461+
403462
def npartypes(self, unitOpId: int) -> int:
404463
"""
405464
Get the number of particle types for a given unit operation.
@@ -1528,6 +1587,26 @@ def solution_times(
15281587
'time', 'nTime', 'getSolutionTimes', own_data=own_data
15291588
)
15301589

1590+
def time_sim(
1591+
self,
1592+
own_data: bool = True,
1593+
) -> float:
1594+
"""
1595+
Load the simulation run time.
1596+
1597+
Parameters
1598+
----------
1599+
own_data : bool, optional
1600+
Whether to copy the data (default is True).
1601+
1602+
Returns
1603+
-------
1604+
float
1605+
The simulation run time.
1606+
"""
1607+
call_outputs = self._load_data('getTimeSim')
1608+
return float(call_outputs['timeSim'].value)
1609+
15311610

15321611
class CadetDLLRunner(CadetRunnerBase):
15331612
"""
@@ -2016,5 +2095,5 @@ def load_meta(self, sim: "Cadet") -> None:
20162095
sim.root.meta.cadet_branch = self.cadet_branch
20172096
sim.root.meta.cadet_commit = self.cadet_commit_hash
20182097
sim.root.meta.cadet_version = self.cadet_version
2019-
sim.root.meta.file_format = None
2020-
sim.root.meta.time_sim = None
2098+
sim.root.meta.file_format = self.res.file_format()
2099+
sim.root.meta.time_sim = self.res.time_sim()

0 commit comments

Comments
 (0)