## On this page
# rocky\_api\_functions
Last update: 17.07.2025
1\#pragma once
2
3// Includes =======================================================================================
4\#include "dll\_export.h"
5
6\#include "rocky\_boundary\_api.hpp"
7
8// Forward declarations ===========================================================================
9class [IRockyPluginData](classIRockyPluginData.xhtml);
10struct [IRockyModel](structIRockyModel.xhtml);
11struct [IRockyDeviceModel](structIRockyDeviceModel.xhtml);
12struct [IRockyContact](structIRockyContact.xhtml);
13struct [IRockyParticle](structIRockyParticle.xhtml);
14struct [IRockyParticleHost](structIRockyParticleHost.xhtml);
15struct [IRockyBreakableParticle](structIRockyBreakableParticle.xhtml);
16struct [IRockyJoint](structIRockyJoint.xhtml);
17
18class [IRockyTimestepData](classIRockyTimestepData.xhtml);
19class [IRockyAdhesiveDistanceData](classIRockyAdhesiveDistanceData.xhtml);
20struct IRockyTimeCurveData;
21struct [IRockyAdhesionOutputData](structIRockyAdhesionOutputData.xhtml);
22struct IRockyJointOutputData;
23struct [IRockyGeometriesMotionData](structIRockyGeometriesMotionData.xhtml);
24struct [IRockyOutputPropertyCollection](structIRockyOutputPropertyCollection.xhtml);
25
26// Functions Prototypes ===========================================================================
27\#ifdef \_\_linux\_\_
28\#define \_\_stdcall
29\#endif
30
31typedef void(__stdcall *configure_f_type)([IRockyPluginData](classIRockyPluginData.xhtml) &_input, void *&data);
32
33// Setup/Tear Down
34typedef void(__stdcall *initialize_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void *data);
35
36typedef void(__stdcall *tear_down_f_type)(const [IRockyModel](structIRockyModel.xhtml) &model, void *data);
37
38typedef void(__stdcall *setup_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void *data);
39
40typedef double(__stdcall *compute_timestep_f_type)(const [IRockyTimestepData](classIRockyTimestepData.xhtml) ×tep_data, void *data);
41
42typedef double(__stdcall *compute_adhesive_distances_f_type)([IRockyAdhesiveDistanceData](classIRockyAdhesiveDistanceData.xhtml) &adhesive_distance_data, void *data);
43
44typedef void(__stdcall *non_dimensionalize_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void *data);
45
46typedef void(__stdcall *initialize_cuda_f_type)(const [IRockyModel](structIRockyModel.xhtml) &model, void *host_data, int device_id, void *&device_data);
47
48typedef void(__stdcall *tear_down_cuda_f_type)(const [IRockyModel](structIRockyModel.xhtml) &model, int device_id, void *device_data);
49
50typedef void(__stdcall *sync_cuda_data_f_type)(const [IRockyModel](structIRockyModel.xhtml) &model, void *host_data, int device_id, void *device_data);
51
52typedef void(__stdcall* initialize_particle_f_type)(const [IRockyModel](structIRockyModel.xhtml)& model, [IRockyParticleHost](structIRockyParticleHost.xhtml)& particle, void* data);
53
54typedef void(__stdcall* initialize_triangle_f_type)(const [IRockyModel](structIRockyModel.xhtml)& model, [IRockyGeometryTriangleHost](structIRockyGeometryTriangleHost.xhtml)& triangle, void* data);
55
56typedef void(__stdcall *initialize_breakage_f_type)(const [IRockyBreakableParticle](structIRockyBreakableParticle.xhtml)& breakable_particle, void* data);
57
58typedef void(__stdcall* setup_output_properties_f_type)(const [IRockyModel](structIRockyModel.xhtml)& model, [IRockyOutputPropertyCollection](structIRockyOutputPropertyCollection.xhtml)& output_property_collection, void* data);
59
60typedef bool(__stdcall *is_valid_f_type)(const [IRockyModel](structIRockyModel.xhtml) &model, void *data);
61
62
63// Output
64typedef void(__stdcall *output_f_type)(const [IRockyModel](structIRockyModel.xhtml) &model, void *data);
65
66typedef double(__stdcall* output_particles_f_type)(const [IRockyModel](structIRockyModel.xhtml)& model, const [IRockyParticleHost](structIRockyParticleHost.xhtml)& particle, int property_id, void* data);
67
68typedef double(__stdcall* output_triangles_f_type)(const [IRockyModel](structIRockyModel.xhtml)& model, const [IRockyGeometryTriangleHost](structIRockyGeometryTriangleHost.xhtml)& triangle, int property_id, void* data);
69
70// Contacts
71typedef void(__stdcall *contacts_f_type)([IRockyDeviceModel](structIRockyDeviceModel.xhtml) &model, [IRockyContact](structIRockyContact.xhtml) &contact, void *data);
72
73typedef void(__stdcall* cuda_contacts_kernel_f_type)([IRockyModel](structIRockyModel.xhtml)& model, void** plugin_devices_data);
74
75typedef void(__stdcall *triangle_wear_f_type)([IRockyContact](structIRockyContact.xhtml)& contact, double& wear_volume, void* data);
76
77typedef void(__stdcall* cuda_triangle_wear_kernel_f_type)([IRockyModel](structIRockyModel.xhtml)& model, void* data);
78
79// Adhesion
80
81typedef void(__stdcall* adhesion_forces_f_type)([IRockyContact](structIRockyContact.xhtml)& contact, [IRockyAdhesionOutputData](structIRockyAdhesionOutputData.xhtml)& output_data, void* data);
82
83typedef void(__stdcall* cuda_adhesion_forces_kernel_f_type)([IRockyModel](structIRockyModel.xhtml)& model, void** plugin_devices_data);
84
85// Particles
86typedef void(__stdcall *particles_f_type)([IRockyDeviceModel](structIRockyDeviceModel.xhtml) &model, [IRockyParticle](structIRockyParticle.xhtml) &particle, void *data);
87
88typedef void(__stdcall *cuda_particles_kernel_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void **plugin_devices_data);
89
90// Triangles
91typedef void(__stdcall* triangles_f_type)([IRockyDeviceModel](structIRockyDeviceModel.xhtml)& model, [IRockyBoundaryTriangle](structIRockyGeometryTriangle.xhtml)& triangle, void* data);
92
93typedef void(__stdcall* cuda_triangles_kernel_f_type)([IRockyModel](structIRockyModel.xhtml)& model, void** plugin_devices_data);
94
95// Instantaneous breakage
96typedef void(__stdcall* instantaneous_breakage_f_type)([IRockyParticle](structIRockyParticle.xhtml)& particle, bool& broken, void* data);
97
98typedef void(__stdcall* cuda_instantaneous_breakage_kernel_f_type)([IRockyModel](structIRockyModel.xhtml)& model, void** plugin_devices_data);
99
100typedef void(__stdcall* fragments_distribution_f_type)([IRockyBreakableParticle](structIRockyBreakableParticle.xhtml)& particle, std::vector<double>& distribution, void* data);
101
102// Joints
103typedef void(__stdcall *joints_f_type)([IRockyDeviceModel](structIRockyDeviceModel.xhtml) &model, [IRockyJoint](structIRockyJoint.xhtml) &joint, void *data);
104
105typedef void(__stdcall *cuda_joints_kernel_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void **plugin_devices_data);
106
107typedef void(__stdcall *joint_forces_f_type)([IRockyJoint](structIRockyJoint.xhtml) &joint, IRockyJointOutputData& output_data, void *data);
108
109typedef void(__stdcall *cuda_joint_forces_kernel_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void **plugin_devices_data);
110
111// Joint breakage
112typedef void(__stdcall* joint_breakage_f_type)([IRockyJoint](structIRockyJoint.xhtml) &joint, bool &broken, void *data);
113
114typedef void(__stdcall* cuda_joint_breakage_kernel_f_type)([IRockyModel](structIRockyModel.xhtml) &model, void **plugin_devices_data);
115
116// Geometry motion
117typedef void(__stdcall *geometries_motion_f_type)([IRockyModel](structIRockyModel.xhtml) &model, [IRockyGeometriesMotionData](structIRockyGeometriesMotionData.xhtml) &motion, void *data);
118
119// Extra macros for Frictional Contact Forces ------------------------------------------------------
120\#include "rocky\_api\_contact\_functions.h"
121
122// Special Functor that wraps a function pointer
123template <typename Function>
124struct Function2Functor
125{
126 template <typename... Args>
127 void operator()(Args&... args)
128 {
129 (*this->function)(args...);
130 }
131 Function function;
132};
133
134// UDF =============================================================================================
135\#define ROCKY\_PLUGIN(plugin\_name, plugin\_version) \\
136 ROCKY\_PLUGIN\_INFO(plugin\_name, plugin\_version) extern "C" {
137
138\#define ROCKY\_PLUGIN\_END \\
139 ROCKY\_PLUGIN\_FINISH\_CONTACT\_MODEL\_FUNCTIONS\_SETUP() }
140
141// Initialization ---------------------------------------------------------------------------------
142\#define ROCKY\_PLUGIN\_CONFIGURE(input\_data, data) \\
143 ROCKYAPI\_EXPORT void configure(const IRockyPluginData &input\_data, void \*&data)
144
145\#define ROCKY\_PLUGIN\_NON\_DIMENSIONALIZE(model, data) \\
146 extern "C" ROCKYAPI\_EXPORT void non\_dimensionalize(IRockyModel &model, void \*data)
147
148\#define ROCKY\_PLUGIN\_INITIALIZE(model, data) \\
149 extern "C" ROCKYAPI\_EXPORT void initialize(IRockyModel &model, void \*data)
150
151\#define ROCKY\_PLUGIN\_TEAR\_DOWN(model, data) \\
152 extern "C" ROCKYAPI\_EXPORT void finish(const IRockyModel &model, void \*data)
153
154\#define ROCKY\_PLUGIN\_SETUP(model, data) \\
155 extern "C" ROCKYAPI\_EXPORT void setup(IRockyModel &model, void \*data)
156
157\#define ROCKY\_PLUGIN\_COMPUTE\_TIMESTEP(timestep\_data, data) \\
158 extern "C" ROCKYAPI\_EXPORT double compute\_timestep(const IRockyTimestepData ×tep\_data, void \*data)
159
160\#define ROCKY\_PLUGIN\_IS\_VALID(model, data) \\
161 extern "C" ROCKYAPI\_EXPORT bool is\_valid(const IRockyModel &model, void \*data)
162
163\#ifdef \_MSC\_VER
164 #define \_STR(x) #x
165 #define STR(x) \_STR(x)
166 #define DO\_PRAGMA\_(x) \_\_pragma (message(\_\_FILE\_\_ "(" STR(\_\_LINE\_\_) ") warning: " x))
167 #define DEPRECATED\_WARNING(message) DO\_PRAGMA\_(message)
168\#else
169 #define DO\_PRAGMA\_(x) \_Pragma (#x)
170 #define DEPRECATED\_WARNING(message) DO\_PRAGMA\_(GCC warning #message)
171\#endif
172
173\#define ROCKY\_PLUGIN\_COMPUTE\_ADHESIVE\_DISTANCES(adhesive\_distance\_data, data) \\
174 extern "C" ROCKYAPI\_EXPORT \\
175 DEPRECATED\_WARNING("'ROCKY\_PLUGIN\_COMPUTE\_ADHESIVE\_DISTANCES' hook is deprecated. Now you can set adhesive distances in ROCKY\_PLUGIN\_INITIALIZE or ROCKY\_PLUGIN\_BEGIN\_ITERATION") \\
176 void compute\_adhesive\_distances(IRockyAdhesiveDistanceData &adhesive\_distance\_data, void \*data)
177
178\#define ROCKY\_PLUGIN\_INITIALIZE\_CUDA(model, host\_data, device\_id, device\_data) \\
179 extern "C" ROCKYAPI\_EXPORT void initialize\_cuda( \\
180 const IRockyModel &model, void \*host\_data, int device\_id, void \*&device\_data)
181
182\#define ROCKY\_PLUGIN\_TEAR\_DOWN\_CUDA(model, device\_id, device\_data) \\
183 extern "C" ROCKYAPI\_EXPORT void finish\_cuda(const IRockyModel &model, int device\_id, void \*device\_data)
184
185\#define ROCKY\_PLUGIN\_INITIALIZE\_PARTICLE(model, particle, data) \\
186 extern "C" ROCKYAPI\_EXPORT void initialize\_particle( \\
187 IRockyModel& model, IRockyParticleHost& particle, void\* data)
188
189\#define ROCKY\_PLUGIN\_INITIALIZE\_TRIANGLE(model, triangle, data) \\
190 extern "C" ROCKYAPI\_EXPORT void initialize\_triangle( \\
191 IRockyModel& model, IRockyGeometryTriangleHost& triangle, void\* data)
192
193\#define ROCKY\_PLUGIN\_INITIALIZE\_INSTANTANEOUS\_BREAKAGE(breakable\_particle, data)\\
194 extern "C" ROCKYAPI\_EXPORT void initialize\_breakage( \\
195 IRockyBreakableParticle& breakable\_particle, void\* data)
196
197\#define ROCKY\_PLUGIN\_INITIALIZE\_FRAGMENTS\_SIZE\_DISTRIBUTION(breakable\_particle, data) \\
198 extern "C" ROCKYAPI\_EXPORT void initialize\_size\_distribution( \\
199 IRockyBreakableParticle& breakable\_particle, void\* data)
200
201\#define ROCKY\_PLUGIN\_SETUP\_OUTPUT\_PROPERTIES(model, output\_property\_collection, data) \\
202 extern "C" ROCKYAPI\_EXPORT void setup\_output\_properties( \\
203 const IRockyModel& model, IRockyOutputPropertyCollection& output\_property\_collection, void\* data)
204
205// Iteration ---------------------------------------------------------------------------------------
206\#define ROCKY\_PLUGIN\_BEGIN\_ITERATION\_CUDA(model, host\_data, device\_id, device\_data) \\
207 extern "C" ROCKYAPI\_EXPORT void begin\_iteration\_cuda( \\
208 const IRockyModel &model, void \*host\_data, int device\_id, void \*&device\_data)
209
210\#define ROCKY\_PLUGIN\_BEGIN\_ITERATION(model, data) \\
211 extern "C" ROCKYAPI\_EXPORT void begin\_iteration(IRockyModel &model, void \*data)
212
213\#define ROCKY\_PLUGIN\_END\_ITERATION\_CUDA(model, host\_data, device\_id, device\_data) \\
214 extern "C" ROCKYAPI\_EXPORT void end\_iteration\_cuda( \\
215 const IRockyModel &model, void \*host\_data, int device\_id, void \*&device\_data)
216
217\#define ROCKY\_PLUGIN\_END\_ITERATION(model, data) \\
218 extern "C" ROCKYAPI\_EXPORT void end\_iteration(IRockyModel &model, void \*data)
219
220// Output ------------------------------------------------------------------------------------------
221\#define ROCKY\_PLUGIN\_PRE\_OUTPUT\_CUDA\_SYNC\_DATA(model, host\_data, device\_id, device\_data) \\
222 extern "C" ROCKYAPI\_EXPORT void pre\_output\_cuda\_sync\_data( \\
223 const IRockyModel& model, void\* host\_data, int device\_id, void\* device\_data)
224
225\#define ROCKY\_PLUGIN\_PRE\_OUTPUT(model, data) \\
226 extern "C" ROCKYAPI\_EXPORT void pre\_output(const IRockyModel& model, void\* data)
227
228\#define ROCKY\_PLUGIN\_PRE\_OUTPUT\_ON\_CONTACTS(device\_model, contact, data) \\
229 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_output\_on\_active\_contacts( \\
230 IRockyDeviceModel &device\_model, IRockyContact &contact, void \*data) {
231
232\#ifndef ROCKY\_CUDA\_API
233\#define ROCKY\_PLUGIN\_PRE\_OUTPUT\_ON\_CONTACTS\_END() }
234\#endif
235
236\#define ROCKY\_PLUGIN\_OUTPUT\_PARTICLE\_PROPERTY(model, particle, property\_id, data) \\
237 extern "C" ROCKYAPI\_EXPORT double output\_particle\_property( \\
238 const IRockyModel& model, IRockyParticleHost& particle, int property\_id, void\* data)
239
240\#define ROCKY\_PLUGIN\_OUTPUT\_TRIANGLE\_PROPERTY(model, triangle, property\_id, data) \\
241 extern "C" ROCKYAPI\_EXPORT double output\_triangle\_property( \\
242 const IRockyModel& model, IRockyGeometryTriangleHost& triangle, int property\_id, void\* data)
243
244\#define ROCKY\_PLUGIN\_POST\_OUTPUT(model, data) \\
245 extern "C" ROCKYAPI\_EXPORT void post\_output(const IRockyModel& model, void\* data)
246
247// Search ------------------------------------------------------------------------------------------
248\#define ROCKY\_PLUGIN\_PRE\_SEARCH\_ON\_PARTICLES(device\_model, particle, data) \\
249 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_search\_on\_particles( \\
250 IRockyDeviceModel &device\_model, IRockyParticle &particle, void \*data) {
251
252\#ifndef ROCKY\_CUDA\_API
253\#define ROCKY\_PLUGIN\_PRE\_SEARCH\_ON\_PARTICLES\_END() }
254\#endif
255
256// Force -------------------------------------------------------------------------------------------
257\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_CONTACTS(device\_model, contact, data) \\
258 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_force\_on\_contacts( \\
259 IRockyDeviceModel &device\_model, IRockyContact &contact, void \*data) {
260
261\#ifndef ROCKY\_CUDA\_API
262\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_CONTACTS\_END() }
263\#endif
264
265\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_PARTICLES(device\_model, particle, data) \\
266 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_force\_on\_particles( \\
267 IRockyDeviceModel &device\_model, IRockyParticle &particle, void \*data) {
268
269\#ifndef ROCKY\_CUDA\_API
270\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_PARTICLES\_END() }
271\#endif
272
273\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_TRIANGLES(device\_model, triangle, data) \\
274 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_force\_on\_triangles( \\
275 IRockyDeviceModel &device\_model, IRockyBoundaryTriangle &triangle, void \*data) {
276
277\#ifndef ROCKY\_CUDA\_API
278\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_TRIANGLES\_END() }
279\#endif
280
281\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_JOINTS(device\_model, joint, data) \\
282 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_force\_on\_joints( \\
283 IRockyDeviceModel &device\_model, IRockyJoint &joint, void \*data) {
284
285\#ifndef ROCKY\_CUDA\_API
286\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_JOINTS\_END() }
287\#endif
288
289\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_CONTACTS(device\_model, contact, data) \\
290 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_force\_on\_contacts( \\
291 IRockyDeviceModel &device\_model, IRockyContact &contact, void \*data) {
292
293\#ifndef ROCKY\_CUDA\_API
294\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_CONTACTS\_END() }
295\#endif
296
297\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_FINISHED\_CONTACTS(device\_model, contact, data) \\
298 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_force\_on\_finished\_contacts( \\
299 IRockyDeviceModel &device\_model, IRockyContact &contact, void \*data) {
300
301\#ifndef ROCKY\_CUDA\_API
302\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_FINISHED\_CONTACTS\_END() }
303\#endif
304
305\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_PARTICLES(device\_model, particle, data) \\
306 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_force\_on\_particles( \\
307 IRockyDeviceModel &device\_model, IRockyParticle &particle, void \*data) {
308
309\#ifndef ROCKY\_CUDA\_API
310\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_PARTICLES\_END() }
311\#endif
312
313\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_TRIANGLES(device\_model, triangle, data) \\
314 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_force\_on\_triangles( \\
315 IRockyDeviceModel &device\_model, IRockyBoundaryTriangle &triangle, void \*data) {
316
317\#ifndef ROCKY\_CUDA\_API
318\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_TRIANGLES\_END() }
319\#endif
320
321\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_JOINTS(device\_model, joint, data) \\
322 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_force\_on\_joints( \\
323 IRockyDeviceModel &device\_model, IRockyJoint &joint, void \*data) {
324
325\#ifndef ROCKY\_CUDA\_API
326\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_JOINTS\_END() }
327\#endif
328
329// Move --------------------------------------------------------------------------------------------
330\#define ROCKY\_PLUGIN\_PRE\_MOVE\_PARTICLES(device\_model, particle, data) \\
331 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_move\_particles( \\
332 IRockyDeviceModel &device\_model, IRockyParticle &particle, void \*data) {
333
334\#ifndef ROCKY\_CUDA\_API
335\#define ROCKY\_PLUGIN\_PRE\_MOVE\_PARTICLES\_END() }
336\#endif
337
338\#define ROCKY\_PLUGIN\_POST\_MOVE\_PARTICLES(device\_model, particle, data) \\
339 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_move\_particles( \\
340 IRockyDeviceModel &device\_model, IRockyParticle &particle, void \*data) {
341
342\#ifndef ROCKY\_CUDA\_API
343\#define ROCKY\_PLUGIN\_POST\_MOVE\_PARTICLES\_END() }
344\#endif
345
346\#define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_TRIANGLES(device\_model, triangle, data) \\
347 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void pre\_move\_triangles( \\
348 IRockyDeviceModel &device\_model, IRockyBoundaryTriangle &triangle, void \*data) {
349
350\#ifndef ROCKY\_CUDA\_API
351\#define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_TRIANGLES\_END() }
352\#endif
353
354\#define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_TRIANGLES(device\_model, triangle, data) \\
355 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void post\_move\_triangles( \\
356 IRockyDeviceModel &device\_model, IRockyBoundaryTriangle &triangle, void \*data) {
357
358\#ifndef ROCKY\_CUDA\_API
359\#define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_TRIANGLES\_END() }
360\#endif
361
362// Adhesive forces ---------------------------------------------------------------------------------------
363
364\#define COMPUTE\_CONTACT\_ADHESIVE\_FORCES\_NAME compute\_contact\_adhesive\_forces
365
366\#define ROCKY\_PLUGIN\_COMPUTE\_CONTACT\_ADHESIVE\_FORCES(contact, output, data) \\
367 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS void COMPUTE\_CONTACT\_ADHESIVE\_FORCES\_NAME( \\
368 IRockyContact& contact, IRockyAdhesionOutputData& output\_data, void\* data) {
369
370\#ifndef ROCKY\_CUDA\_API
371\#define ROCKY\_PLUGIN\_COMPUTE\_CONTACT\_ADHESIVE\_FORCES\_END() }
372\#endif
373
374// Joint forces ------------------------------------------------------------------------------------------
375
376\#define COMPUTE\_JOINT\_FORCES\_NAME compute\_joint\_forces
377
378\#define ROCKY\_PLUGIN\_COMPUTE\_JOINT\_FORCES(joint, output\_data, data) \\
379 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS \\
380 void COMPUTE\_JOINT\_FORCES\_NAME(IRockyJoint &joint, IRockyJointOutputData& output\_data, void \*data) {
381
382\#ifndef ROCKY\_CUDA\_API
383\#define ROCKY\_PLUGIN\_COMPUTE\_JOINT\_FORCES\_END() }
384\#endif
385
386// Joint breakage ----------------------------------------------------------------------------------
387
388\#define COMPUTE\_JOINT\_BREAKAGE\_NAME compute\_joint\_breakage
389
390\#define ROCKY\_PLUGIN\_COMPUTE\_JOINT\_BREAKAGE(joint, broken, data) \\
391 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS \\
392 void COMPUTE\_JOINT\_BREAKAGE\_NAME(IRockyJoint &joint, bool &broken, void \*data) {
393
394\#ifndef ROCKY\_CUDA\_API
395\#define ROCKY\_PLUGIN\_COMPUTE\_JOINT\_BREAKAGE\_END() }
396\#endif
397
398// Instantaneous breakage --------------------------------------------------------------------------
399
400\#define COMPUTE\_INSTANTANEOUS\_BREAKAGE\_NAME compute\_instantaneous\_breakage
401
402\#define ROCKY\_PLUGIN\_COMPUTE\_INSTANTANEOUS\_BREAKAGE(particle, broken, data) \\
403 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS \\
404 void COMPUTE\_INSTANTANEOUS\_BREAKAGE\_NAME(IRockyParticle &particle, bool &broken, void \*data) {
405
406\#ifndef ROCKY\_CUDA\_API
407\#define ROCKY\_PLUGIN\_COMPUTE\_INSTANTANEOUS\_BREAKAGE\_END() }
408\#endif
409
410// Fragments size distribution ---------------------------------------------------------------------
411
412\#define COMPUTE\_SIZE\_DISTRIBUTION\_NAME compute\_fragments\_size\_distribution
413
414\#define ROCKY\_PLUGIN\_COMPUTE\_FRAGMENTS\_SIZE\_DISTRIBUTION(breakable\_particle, distribution, data) \\
415 extern "C" ROCKYAPI\_EXPORT \\
416 void COMPUTE\_SIZE\_DISTRIBUTION\_NAME(IRockyBreakableParticle &breakable\_particle, std::vector<double>& distribution, void \*data) {
417
418\#define ROCKY\_PLUGIN\_COMPUTE\_FRAGMENTS\_SIZE\_DISTRIBUTION\_END() }
419
420// Boundaries wear ---------------------------------------------------------------------------------
421
422\#define COMPUTE\_BOUNDARIES\_WEAR\_NAME compute\_boundaries\_wear
423
424\#define ROCKY\_PLUGIN\_COMPUTE\_BOUNDARIES\_WEAR(triangle\_contact, wear\_volume, data) \\
425 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS \\
426 void COMPUTE\_BOUNDARIES\_WEAR\_NAME(IRockyContact &triangle\_contact, double& wear\_volume, void \*data) {
427
428\#ifndef ROCKY\_CUDA\_API
429\#define ROCKY\_PLUGIN\_COMPUTE\_BOUNDARIES\_WEAR\_END() }
430\#endif
431
432// Thermal -----------------------------------------------------------------------------------------
433\#define COMPUTE\_FRICTIONAL\_HEAT\_CONDUCTION\_NAME compute\_contact\_heat\_conduction
434
435\#define ROCKY\_PLUGIN\_COMPUTE\_CONTACT\_HEAT\_CONDUCTION(model, contact, data) \\
436 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS \\
437 void COMPUTE\_FRICTIONAL\_HEAT\_CONDUCTION\_NAME( \\
438 IRockyDeviceModel &model, IRockyContact &contact, void \*data) {
439
440\#ifndef ROCKY\_CUDA\_API
441\#define ROCKY\_PLUGIN\_COMPUTE\_CONTACT\_HEAT\_CONDUCTION\_END() }
442\#endif
443
444\#define COMPUTE\_THERMAL\_INTEGRATION\_NAME compute\_thermal\_integration
445
446\#define ROCKY\_PLUGIN\_COMPUTE\_THERMAL\_INTEGRATION(model, particle, data) \\
447 extern "C" ROCKYAPI\_EXPORT ROCKY\_FUNCTIONS \\
448 void COMPUTE\_THERMAL\_INTEGRATION\_NAME( \\
449 IRockyDeviceModel &model, IRockyParticle &particle, void \*data) {
450
451\#ifndef ROCKY\_CUDA\_API
452\#define ROCKY\_PLUGIN\_COMPUTE\_THERMAL\_INTEGRATION\_END() }
453\#endif
454
455// Geometry motion ---------------------------------------------------------------------------------
456\#define ROCKY\_PLUGIN\_COMPUTE\_GEOMETRIES\_MOTION(model, motion, data) \\
457 extern "C" ROCKYAPI\_EXPORT void compute\_geometries\_motion(IRockyModel &model, IRockyGeometriesMotionData &motion, void \*data)
458
459// CUDA ============================================================================================
460
461\#ifdef ROCKY\_CUDA\_API
462
463 // on particles
464 #define ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(func\_name) \\
465 struct f\_##func\_name##\_type \\
466 { \\
467 ROCKY\_FUNCTIONS void operator()( \\
468 IRockyDeviceModel& device\_model\_api, IRockyParticle& particle\_api, void\* udf\_data) \\
469 { \\
470 func\_name(device\_model\_api, particle\_api, udf\_data); \\
471 } \\
472 }; \\
473 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
474 IRockyModel& model, void\*\* plugin\_device\_data) \\
475 { \\
476 f\_##func\_name##\_type device\_functor {}; \\
477 rocky::cuda::dispatch\_particles\_kernel(model, device\_functor, plugin\_device\_data); \\
478 }
479
480 // on triangles
481 #define ROCKY\_PLUGIN\_TRIANGLES\_CUDA\_KERNEL(func\_name) \\
482 struct f\_##func\_name##\_type \\
483 { \\
484 ROCKY\_FUNCTIONS void operator()( \\
485 IRockyDeviceModel& device\_model\_api, \\
486 IRockyBoundaryTriangle& triangle\_api, \\
487 void\* udf\_data) \\
488 { \\
489 func\_name(device\_model\_api, triangle\_api, udf\_data); \\
490 } \\
491 }; \\
492 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
493 IRockyModel& model, void\*\* plugin\_device\_data) \\
494 { \\
495 f\_##func\_name##\_type device\_functor {}; \\
496 rocky::cuda::dispatch\_triangles\_kernel(model, device\_functor, plugin\_device\_data); \\
497 }
498
499 // on contacts
500 #define ROCKY\_PLUGIN\_CONTACTS\_CUDA\_KERNEL(func\_name, c\_type) \\
501 struct f\_##func\_name##\_type \\
502 { \\
503 ROCKY\_FUNCTIONS void operator()( \\
504 IRockyDeviceModel& device\_model\_api, IRockyContact& contact\_api, void\* udf\_data) \\
505 { \\
506 func\_name(device\_model\_api, contact\_api, udf\_data); \\
507 } \\
508 }; \\
509 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
510 IRockyModel& model, void\*\* plugin\_device\_data) \\
511 { \\
512 f\_##func\_name##\_type device\_functor {}; \\
513 rocky::cuda::dispatch\_##c\_type##\_contacts\_kernel( \\
514 model, device\_functor, device\_functor, plugin\_device\_data); \\
515 }
516
517 // on joints
518 #define ROCKY\_PLUGIN\_JOINTS\_CUDA\_KERNEL(func\_name) \\
519 struct f\_##func\_name##\_type \\
520 { \\
521 ROCKY\_FUNCTIONS void operator()( \\
522 IRockyDeviceModel& device\_model\_api, IRockyJoint& joint\_api, void\* udf\_data) \\
523 { \\
524 func\_name(device\_model\_api, joint\_api, udf\_data); \\
525 } \\
526 }; \\
527 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
528 IRockyModel& model, void\*\* plugin\_device\_data) \\
529 { \\
530 f\_##func\_name##\_type device\_functor {}; \\
531 rocky::cuda::dispatch\_joints\_kernel(model, device\_functor, plugin\_device\_data); \\
532 }
533
534 // Search --------------------------------------------------------------------------------------
535 #define ROCKY\_PLUGIN\_PRE\_SEARCH\_ON\_PARTICLES\_END() \\
536 } \\
537 ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(pre\_search\_on\_particles)
538
539 // Force ---------------------------------------------------------------------------------------
540 #define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_CONTACTS\_END() \\
541 } \\
542 ROCKY\_PLUGIN\_CONTACTS\_CUDA\_KERNEL(pre\_force\_on\_contacts, frictional)
543
544 #define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_PARTICLES\_END() \\
545 } \\
546 ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(pre\_force\_on\_particles)
547
548 #define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_TRIANGLES\_END() \\
549 } \\
550 ROCKY\_PLUGIN\_TRIANGLES\_CUDA\_KERNEL(pre\_force\_on\_triangles)
551
552 #define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_JOINTS\_END() \\
553 } \\
554 ROCKY\_PLUGIN\_JOINTS\_CUDA\_KERNEL(pre\_force\_on\_joints)
555
556 #define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_CONTACTS\_END() \\
557 } \\
558 ROCKY\_PLUGIN\_CONTACTS\_CUDA\_KERNEL(post\_force\_on\_contacts, frictional)
559
560 #define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_PARTICLES\_END() \\
561 } \\
562 ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(post\_force\_on\_particles)
563
564 #define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_TRIANGLES\_END() \\
565 } \\
566 ROCKY\_PLUGIN\_TRIANGLES\_CUDA\_KERNEL(post\_force\_on\_triangles)
567
568 #define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_JOINTS\_END() \\
569 } \\
570 ROCKY\_PLUGIN\_JOINTS\_CUDA\_KERNEL(post\_force\_on\_joints)
571
572 #define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_FINISHED\_CONTACTS\_END() \\
573 } \\
574 ROCKY\_PLUGIN\_CONTACTS\_CUDA\_KERNEL(post\_force\_on\_finished\_contacts, finished)
575
576 #define ROCKY\_PLUGIN\_PRE\_OUTPUT\_ON\_CONTACTS\_END() \\
577 } \\
578 ROCKY\_PLUGIN\_CONTACTS\_CUDA\_KERNEL(pre\_output\_on\_active\_contacts, active)
579
580 // Move ----------------------------------------------------------------------------------------
581 #define ROCKY\_PLUGIN\_PRE\_MOVE\_PARTICLES\_CUDA() \\
582 ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(pre\_move\_particles)
583
584 #define ROCKY\_PLUGIN\_PRE\_MOVE\_PARTICLES\_END() \\
585 } \\
586 ROCKY\_PLUGIN\_PRE\_MOVE\_PARTICLES\_CUDA()
587
588 #define ROCKY\_PLUGIN\_POST\_MOVE\_PARTICLES\_CUDA() \\
589 ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(post\_move\_particles)
590
591 #define ROCKY\_PLUGIN\_POST\_MOVE\_PARTICLES\_END() \\
592 } \\
593 ROCKY\_PLUGIN\_POST\_MOVE\_PARTICLES\_CUDA()
594
595 #define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_TRIANGLES\_CUDA() \\
596 ROCKY\_PLUGIN\_TRIANGLES\_CUDA\_KERNEL(pre\_move\_triangles)
597
598 #define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_TRIANGLES\_END() \\
599 } \\
600 ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_TRIANGLES\_CUDA()
601
602 #define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_TRIANGLES\_CUDA() \\
603 ROCKY\_PLUGIN\_TRIANGLES\_CUDA\_KERNEL(post\_move\_triangles)
604
605 #define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_TRIANGLES\_END() \\
606 } \\
607 ROCKY\_PLUGIN\_POST\_MOVE\_ON\_TRIANGLES\_CUDA()
608
609// Contact adhesive forces -------------------------------------------------------------------------
610
611 #define ROCKY\_PLUGIN\_CONTACT\_ADHESIVE\_FORCES\_CUDA\_KERNEL(func\_name) \\
612 struct f\_##func\_name##\_type \\
613 { \\
614 ROCKY\_FUNCTIONS void operator()( \\
615 IRockyContact& contact\_api, \\
616 IRockyAdhesionOutputData& output\_data\_api, \\
617 void\* udf\_data) \\
618 { \\
619 func\_name(contact\_api, output\_data\_api, udf\_data); \\
620 } \\
621 }; \\
622 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
623 IRockyModel& model, void\*\* plugin\_device\_data) \\
624 { \\
625 f\_##func\_name##\_type device\_functor {}; \\
626 rocky::cuda::dispatch\_adhesive\_contact\_forces\_kernel( \\
627 model, device\_functor, device\_functor, plugin\_device\_data); \\
628 }
629
630 #define ROCKY\_PLUGIN\_COMPUTE\_CONTACT\_ADHESIVE\_FORCES\_END() \\
631 } \\
632 ROCKY\_PLUGIN\_CONTACT\_ADHESIVE\_FORCES\_CUDA\_KERNEL(compute\_contact\_adhesive\_forces)
633
634// Joint forces ------------------------------------------------------------------------------------
635
636 #define ROCKY\_PLUGIN\_JOINT\_FORCES\_CUDA\_KERNEL(func\_name) \\
637 struct f\_##func\_name##\_type \\
638 { \\
639 ROCKY\_FUNCTIONS void operator()( \\
640 IRockyJoint& joint\_api, IRockyJointOutputData& output\_data\_api, void\* udf\_data) \\
641 { \\
642 func\_name(joint\_api, output\_data\_api, udf\_data); \\
643 } \\
644 }; \\
645 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
646 IRockyModel& model, void\*\* plugin\_device\_data) \\
647 { \\
648 f\_##func\_name##\_type device\_functor {}; \\
649 rocky::cuda::dispatch\_joint\_forces\_kernel(model, device\_functor, plugin\_device\_data); \\
650 }
651
652 #define ROCKY\_PLUGIN\_COMPUTE\_JOINT\_FORCES\_END() \\
653 } \\
654 ROCKY\_PLUGIN\_JOINT\_FORCES\_CUDA\_KERNEL(compute\_joint\_forces)
655
656// Joint breakage ------------------------------------------------------------------------------
657
658 #define ROCKY\_PLUGIN\_JOINT\_BREAKAGE\_CUDA\_KERNEL(func\_name) \\
659 struct f\_##func\_name##\_type \\
660 { \\
661 ROCKY\_FUNCTIONS void operator()(IRockyJoint& joint\_api, bool& broken, void\* udf\_data) \\
662 { \\
663 func\_name(joint\_api, broken, udf\_data); \\
664 } \\
665 }; \\
666 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
667 IRockyModel& model, void\*\* plugin\_device\_data) \\
668 { \\
669 f\_##func\_name##\_type device\_functor {}; \\
670 rocky::cuda::dispatch\_joint\_breakage\_kernel( \\
671 model, device\_functor, plugin\_device\_data); \\
672 }
673
674 #define ROCKY\_PLUGIN\_COMPUTE\_JOINT\_BREAKAGE\_END() \\
675 } \\
676 ROCKY\_PLUGIN\_JOINT\_BREAKAGE\_CUDA\_KERNEL(compute\_joint\_breakage)
677
678// Instantaneous breakage --------------------------------------------------------------------------
679
680 #define ROCKY\_PLUGIN\_INSTANTANEOUS\_BREAKAGE\_CUDA\_KERNEL(func\_name) \\
681 struct f\_##func\_name##\_type \\
682 { \\
683 ROCKY\_FUNCTIONS void operator()( \\
684 IRockyParticle& particle\_api, bool& broken, void\* udf\_data) \\
685 { \\
686 func\_name(particle\_api, broken, udf\_data); \\
687 } \\
688 }; \\
689 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
690 IRockyModel& model, void\*\* plugin\_device\_data) \\
691 { \\
692 f\_##func\_name##\_type device\_functor {}; \\
693 rocky::cuda::dispatch\_instantaneous\_breakage\_kernel( \\
694 model, device\_functor, plugin\_device\_data); \\
695 }
696
697 #define ROCKY\_PLUGIN\_COMPUTE\_INSTANTANEOUS\_BREAKAGE\_END() \\
698 } \\
699 ROCKY\_PLUGIN\_INSTANTANEOUS\_BREAKAGE\_CUDA\_KERNEL(compute\_instantaneous\_breakage)
700
701// Boundaries wear ---------------------------------------------------------------------------------
702
703 #define ROCKY\_PLUGIN\_COMPUTE\_BOUNDARIES\_WEAR\_CUDA\_KERNEL(func\_name) \\
704 struct f\_##func\_name##\_type \\
705 { \\
706 ROCKY\_FUNCTIONS void operator()( \\
707 IRockyContact& contact\_api, double& wear\_volume, void\* udf\_data) \\
708 { \\
709 func\_name(contact\_api, wear\_volume, udf\_data); \\
710 } \\
711 }; \\
712 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
713 IRockyModel& model, void\*\* plugin\_device\_data) \\
714 { \\
715 f\_##func\_name##\_type device\_functor {}; \\
716 rocky::cuda::dispatch\_boundaries\_wear\_kernel( \\
717 model, device\_functor, plugin\_device\_data); \\
718 }
719
720 #define ROCKY\_PLUGIN\_COMPUTE\_BOUNDARIES\_WEAR\_END() \\
721 } \\
722 ROCKY\_PLUGIN\_COMPUTE\_BOUNDARIES\_WEAR\_CUDA\_KERNEL(compute\_boundaries\_wear)
723
724// Contact Data Gathering --------------------------------------------------------------------------
725
726 #define ROCKY\_PLUGIN\_ALL\_CONTACTS\_CUDA\_KERNEL(func\_name) \\
727 struct f\_##func\_name##\_type \\
728 { \\
729 ROCKY\_FUNCTIONS void operator()( \\
730 IRockyDeviceModel& device\_model\_api, IRockyContact& contact\_api, void\* udf\_data) \\
731 { \\
732 func\_name(device\_model\_api, contact\_api, udf\_data); \\
733 } \\
734 }; \\
735 extern "C" ROCKYAPI\_EXPORT void cuda\_##func\_name##\_kernel( \\
736 IRockyModel& model, void\*\* plugin\_device\_data) \\
737 { \\
738 f\_##func\_name##\_type device\_functor {}; \\
739 rocky::cuda::dispatch\_all\_contacts\_kernel( \\
740 model, device\_model, device\_model, plugin\_device\_data); \\
741 }
742
743 #define ROCKY\_PLUGIN\_COLLECT\_CONTACTS\_DATA\_END() \\
744 } \\
745 ROCKY\_PLUGIN\_ALL\_CONTACTS\_CUDA\_KERNEL(collect\_contacts\_data)
746
747// Thermal -----------------------------------------------------------------------------------------
748 #define ROCKY\_PLUGIN\_COMPUTE\_CONTACT\_HEAT\_CONDUCTION\_END() \\
749 } \\
750 ROCKY\_PLUGIN\_CONTACTS\_CUDA\_KERNEL(compute\_contact\_heat\_conduction, frictional)
751
752 #define ROCKY\_PLUGIN\_COMPUTE\_THERMAL\_INTEGRATION\_END() \\
753 } \\
754 ROCKY\_PLUGIN\_PARTICLES\_CUDA\_KERNEL(compute\_thermal\_integration)
755
756\#endif // ROCKY\_CUDA\_API
[IRockyAdhesiveDistanceData](classIRockyAdhesiveDistanceData.xhtml)
**Definition** rocky_timestep_api.h:189
[IRockyPluginData](classIRockyPluginData.xhtml)
**Definition** rocky_plugin_data.h:112
[IRockyTimestepData](classIRockyTimestepData.xhtml)
**Definition** rocky_timestep_api.h:152
[IRockyAdhesionOutputData](structIRockyAdhesionOutputData.xhtml)
**Definition** rocky_contact_output_data_api.hpp:303
[IRockyBreakableParticle](structIRockyBreakableParticle.xhtml)
**Definition** rocky_particle_api.hpp:649
[IRockyContact](structIRockyContact.xhtml)
**Definition** rocky_contact_api.hpp:46
[IRockyDeviceModel](structIRockyDeviceModel.xhtml)
**Definition** rocky_model_api.hpp:19
[IRockyGeometriesMotionData](structIRockyGeometriesMotionData.xhtml)
**Definition** rocky_boundary_api.hpp:684
[IRockyGeometryTriangleHost](structIRockyGeometryTriangleHost.xhtml)
**Definition** rocky_boundary_api.hpp:285
[IRockyGeometryTriangle](structIRockyGeometryTriangle.xhtml)
**Definition** rocky_boundary_api.hpp:134
[IRockyJoint](structIRockyJoint.xhtml)
**Definition** rocky_joint_api.hpp:32
[IRockyModel](structIRockyModel.xhtml)
**Definition** rocky_api.h:60
[IRockyOutputPropertyCollection](structIRockyOutputPropertyCollection.xhtml)
**Definition** rocky_output_collections_api.hpp:555
[IRockyParticleHost](structIRockyParticleHost.xhtml)
**Definition** rocky_particle_api.hpp:766
[IRockyParticle](structIRockyParticle.xhtml)
**Definition** rocky_particle_api.hpp:27