## On this page

  

 

 # rocky\_api\_cfd\_functions

 Last update: 17.07.2025 

<a id="l00001" name="l00001"></a> 1\#pragma once

<a id="l00002" name="l00002"></a> 2 

<a id="l00003" name="l00003"></a> 3 

<a id="l00004" name="l00004"></a> 4// Functions Prototypes ===========================================================================

<a id="l00005" name="l00005"></a> 5\#ifdef \_\_linux\_\_

<a id="l00006" name="l00006"></a> 6\#define \_\_stdcall

<a id="l00007" name="l00007"></a> 7\#endif

<a id="l00008" name="l00008"></a> 8 

<a id="l00009" name="l00009"></a> 9typedef void(__stdcall* cfd_coupling_kernel_f_type)(

<a id="l00010" name="l00010"></a> 10 [IRockyModel](structIRockyModel.xhtml)&amp; model, DeviceParticleGroupData* device_group_data, void** plugin_device_data);

<a id="l00011" name="l00011"></a> 11 

<a id="l00012" name="l00012"></a> 12typedef void(__stdcall* cfd_coupling_data_kernel_f_type)(

<a id="l00013" name="l00013"></a> 13 [IRockyModel](structIRockyModel.xhtml)&amp; model, void** plugin_devices_data);

<a id="l00014" name="l00014"></a> 14 

<a id="l00015" name="l00015"></a> 15 

<a id="l00016" name="l00016"></a> 16// -----------------------------------------------------------------------------------------------

<a id="l00017" name="l00017"></a> 17\#define ROCKY\_PLUGIN\_CFD\_COUPLING() \\

<a id="l00018" name="l00018"></a> 18 } /\* extern "C" closing scope \*/ \\

<a id="l00019" name="l00019"></a> 19 struct \_CouplingPlugin {};

<a id="l00020" name="l00020"></a> 20 

<a id="l00021" name="l00021"></a> 21// -----------------------------------------------------------------------------------------------

<a id="l00022" name="l00022"></a> 22\#define COUPLING\_LAW\_COEFFICIENT(\_coeff) \\

<a id="l00023" name="l00023"></a> 23struct \_CouplingPlugin\_ ## \_coeff ## \_Operator { \\

<a id="l00024" name="l00024"></a> 24 static inline ROCKY\_FUNCTIONS double \_coeff( \\

<a id="l00025" name="l00025"></a> 25 const IRockyParticle&amp; particle, const IRockyCFDProperties&amp; cfd, void \*data) \\

<a id="l00026" name="l00026"></a> 26 {

<a id="l00027" name="l00027"></a> 27 

<a id="l00028" name="l00028"></a> 28 

<a id="l00029" name="l00029"></a> 29\#define COUPLING\_LAW\_COEFFICIENT\_END(\_coeff, \_name, \_law) \\

<a id="l00030" name="l00030"></a> 30}}; \\

<a id="l00031" name="l00031"></a> 31 \\

<a id="l00032" name="l00032"></a> 32namespace device { \\

<a id="l00033" name="l00033"></a> 33template &lt;&gt; \\

<a id="l00034" name="l00034"></a> 34auto custom\_ ## \_name ## \_operator&lt;\_CouplingPlugin&gt;() \\

<a id="l00035" name="l00035"></a> 35 { return device::\_law&lt;\_CouplingPlugin\_ ## \_coeff ## \_Operator&gt;(); } \\

<a id="l00036" name="l00036"></a> 36}

<a id="l00037" name="l00037"></a> 37 

<a id="l00038" name="l00038"></a> 38\#define COUPLING\_LAW\_COEFFICIENT\_WITH\_DEVICE\_END(\_coeff, \_name, \_law) \\

<a id="l00039" name="l00039"></a> 39}}; \\

<a id="l00040" name="l00040"></a> 40 \\

<a id="l00041" name="l00041"></a> 41namespace device { \\

<a id="l00042" name="l00042"></a> 42template &lt;&gt; \\

<a id="l00043" name="l00043"></a> 43auto custom\_ ## \_name ## \_operator&lt;\_CouplingPlugin&gt;(SDeviceModel \*device\_data) \\

<a id="l00044" name="l00044"></a> 44 { return device::\_law&lt;\_CouplingPlugin\_ ## \_coeff ## \_Operator&gt;{ device\_data }; } \\

<a id="l00045" name="l00045"></a> 45}

<a id="l00046" name="l00046"></a> 46 

<a id="l00047" name="l00047"></a> 47// Drag

<a id="l00048" name="l00048"></a> 48// -----------------------------------------------------------------------------------------------

<a id="l00049" name="l00049"></a> 49\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_DRAG\_COEFFICIENT(particle, cfd, data) \\

<a id="l00050" name="l00050"></a> 50 COUPLING\_LAW\_COEFFICIENT(C\_D) \\

<a id="l00051" name="l00051"></a> 51 

<a id="l00052" name="l00052"></a> 52// -----------------------------------------------------------------------------------------------

<a id="l00053" name="l00053"></a> 53\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_DRAG\_COEFFICIENT\_END() \\

<a id="l00054" name="l00054"></a> 54 COUPLING\_LAW\_COEFFICIENT\_END(C\_D, drag, DragParametricOperator) \\

<a id="l00055" name="l00055"></a> 55 

<a id="l00056" name="l00056"></a> 56// Lift

<a id="l00057" name="l00057"></a> 57// -----------------------------------------------------------------------------------------------

<a id="l00058" name="l00058"></a> 58\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_LIFT\_COEFFICIENT(particle, cfd, data) \\

<a id="l00059" name="l00059"></a> 59 COUPLING\_LAW\_COEFFICIENT(C\_L) \\

<a id="l00060" name="l00060"></a> 60 

<a id="l00061" name="l00061"></a> 61// -----------------------------------------------------------------------------------------------

<a id="l00062" name="l00062"></a> 62\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_LIFT\_COEFFICIENT\_END() \\

<a id="l00063" name="l00063"></a> 63 COUPLING\_LAW\_COEFFICIENT\_END(C\_L, lift, LiftParametricOperator) \\

<a id="l00064" name="l00064"></a> 64 

<a id="l00065" name="l00065"></a> 65// Virtual Mass

<a id="l00066" name="l00066"></a> 66// -----------------------------------------------------------------------------------------------

<a id="l00067" name="l00067"></a> 67\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_VIRTUAL\_MASS\_COEFFICIENT(particle, cfd, data) \\

<a id="l00068" name="l00068"></a> 68 COUPLING\_LAW\_COEFFICIENT(C\_VM) \\

<a id="l00069" name="l00069"></a> 69 

<a id="l00070" name="l00070"></a> 70// -----------------------------------------------------------------------------------------------

<a id="l00071" name="l00071"></a> 71\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_VIRTUAL\_MASS\_COEFFICIENT\_END() \\

<a id="l00072" name="l00072"></a> 72 COUPLING\_LAW\_COEFFICIENT\_WITH\_DEVICE\_END(C\_VM, virtual\_mass, VirtualMassParametricOperator) \\

<a id="l00073" name="l00073"></a> 73 

<a id="l00074" name="l00074"></a> 74// Torque

<a id="l00075" name="l00075"></a> 75// -----------------------------------------------------------------------------------------------

<a id="l00076" name="l00076"></a> 76\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_TORQUE\_COEFFICIENT(particle, cfd, data) \\

<a id="l00077" name="l00077"></a> 77 COUPLING\_LAW\_COEFFICIENT(C\_T) \\

<a id="l00078" name="l00078"></a> 78 

<a id="l00079" name="l00079"></a> 79// -----------------------------------------------------------------------------------------------

<a id="l00080" name="l00080"></a> 80\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_TORQUE\_COEFFICIENT\_END() \\

<a id="l00081" name="l00081"></a> 81 COUPLING\_LAW\_COEFFICIENT\_END(C\_T, torque, TorqueParametricOperator) \\

<a id="l00082" name="l00082"></a> 82 

<a id="l00083" name="l00083"></a> 83// Heat Convection

<a id="l00084" name="l00084"></a> 84// -----------------------------------------------------------------------------------------------

<a id="l00085" name="l00085"></a> 85\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_NUSSELT\_NUMBER(particle, cfd, data) \\

<a id="l00086" name="l00086"></a> 86 COUPLING\_LAW\_COEFFICIENT(Nu) \\

<a id="l00087" name="l00087"></a> 87 

<a id="l00088" name="l00088"></a> 88// -----------------------------------------------------------------------------------------------

<a id="l00089" name="l00089"></a> 89\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_NUSSELT\_NUMBER\_END() \\

<a id="l00090" name="l00090"></a> 90 COUPLING\_LAW\_COEFFICIENT\_WITH\_DEVICE\_END(Nu, convection, HeatConvectionParametricOperator) \\

<a id="l00091" name="l00091"></a> 91 

<a id="l00092" name="l00092"></a> 92// -----------------------------------------------------------------------------------------------

<a id="l00093" name="l00093"></a> 93\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_KERNEL(scope) \\

<a id="l00094" name="l00094"></a> 94 extern "C" ROCKYAPI\_EXPORT void scope ## \_dispatch\_cfd\_coupling\_kernel( \\

<a id="l00095" name="l00095"></a> 95 IRockyModel &amp;model, \\

<a id="l00096" name="l00096"></a> 96 DeviceParticleGroupData\* device\_group\_data, \\

<a id="l00097" name="l00097"></a> 97 void \*\*plugin\_device\_data) \\

<a id="l00098" name="l00098"></a> 98 { \\

<a id="l00099" name="l00099"></a> 99 rocky::scope::select\_and\_dispatch\_cfd\_coupling\_kernel&lt;\_CouplingPlugin&gt;( \\

<a id="l00100" name="l00100"></a> 100 model, device\_group\_data, \\

<a id="l00101" name="l00101"></a> 101 plugin\_device\_data); \\

<a id="l00102" name="l00102"></a> 102 }

<a id="l00103" name="l00103"></a> 103 

<a id="l00104" name="l00104"></a> 104 

<a id="l00105" name="l00105"></a> 105// -----------------------------------------------------------------------------------------------

<a id="l00106" name="l00106"></a> 106\#define ROCKY\_PLUGIN\_ON\_FLUID(model, particle, cfd, data, step\_name) \\

<a id="l00107" name="l00107"></a> 107 struct step\_name ## \_Operator { \\

<a id="l00108" name="l00108"></a> 108 ROCKY\_FUNCTIONS void operator()( \\

<a id="l00109" name="l00109"></a> 109 IRockyDeviceModel &amp;model, \\

<a id="l00110" name="l00110"></a> 110 IRockyParticle&amp; particle, const IRockyCFDProperties&amp; cfd, void \*data) {

<a id="l00111" name="l00111"></a> 111 

<a id="l00112" name="l00112"></a> 112\#define ROCKY\_PLUGIN\_ON\_FLUID\_END() }}; \\

<a id="l00113" name="l00113"></a> 113 

<a id="l00114" name="l00114"></a> 114\#define ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(step\_name, scope) \\

<a id="l00115" name="l00115"></a> 115 extern "C" ROCKYAPI\_EXPORT void scope ## \_ ## step\_name ## \_on\_fluid\_kernel( \\

<a id="l00116" name="l00116"></a> 116 IRockyModel &amp;model, \\

<a id="l00117" name="l00117"></a> 117 void \*\*plugin\_device\_data) \\

<a id="l00118" name="l00118"></a> 118 { \\

<a id="l00119" name="l00119"></a> 119 rocky::scope::dispatch\_fluid\_kernel(model, step\_name ## \_Operator(), plugin\_device\_data); \\

<a id="l00120" name="l00120"></a> 120 }

<a id="l00121" name="l00121"></a> 121 

<a id="l00122" name="l00122"></a> 122 

<a id="l00123" name="l00123"></a> 123\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_FLUID(model, particle, cfd, data) \\

<a id="l00124" name="l00124"></a> 124 ROCKY\_PLUGIN\_ON\_FLUID(model, particle, cfd, data, pre\_force)

<a id="l00125" name="l00125"></a> 125 

<a id="l00126" name="l00126"></a> 126\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_FLUID(model, particle, cfd, data) \\

<a id="l00127" name="l00127"></a> 127 ROCKY\_PLUGIN\_ON\_FLUID(model, particle, cfd, data, post\_force)

<a id="l00128" name="l00128"></a> 128 

<a id="l00129" name="l00129"></a> 129\#define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_FLUID(model, particle, cfd, data) \\

<a id="l00130" name="l00130"></a> 130 ROCKY\_PLUGIN\_ON\_FLUID(model, particle, cfd, data, pre\_move)

<a id="l00131" name="l00131"></a> 131 

<a id="l00132" name="l00132"></a> 132\#define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_FLUID(model, particle, cfd, data) \\

<a id="l00133" name="l00133"></a> 133 ROCKY\_PLUGIN\_ON\_FLUID(model, particle, cfd, data, post\_move)

<a id="l00134" name="l00134"></a> 134 

<a id="l00135" name="l00135"></a> 135\#ifdef ROCKY\_CUDA\_API

<a id="l00136" name="l00136"></a> 136 

<a id="l00137" name="l00137"></a> 137\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_FLUID\_END() \\

<a id="l00138" name="l00138"></a> 138 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00139" name="l00139"></a> 139 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(pre\_force, omp) \\

<a id="l00140" name="l00140"></a> 140 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(pre\_force, cuda)

<a id="l00141" name="l00141"></a> 141 

<a id="l00142" name="l00142"></a> 142\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_FLUID\_END() \\

<a id="l00143" name="l00143"></a> 143 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00144" name="l00144"></a> 144 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(post\_force, omp) \\

<a id="l00145" name="l00145"></a> 145 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(post\_force, cuda)

<a id="l00146" name="l00146"></a> 146 

<a id="l00147" name="l00147"></a> 147\#define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_FLUID\_END() \\

<a id="l00148" name="l00148"></a> 148 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00149" name="l00149"></a> 149 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(pre\_move, omp) \\

<a id="l00150" name="l00150"></a> 150 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(pre\_move, cuda)

<a id="l00151" name="l00151"></a> 151 

<a id="l00152" name="l00152"></a> 152\#define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_FLUID\_END() \\

<a id="l00153" name="l00153"></a> 153 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00154" name="l00154"></a> 154 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(post\_move, omp) \\

<a id="l00155" name="l00155"></a> 155 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(post\_move, cuda)

<a id="l00156" name="l00156"></a> 156 

<a id="l00157" name="l00157"></a> 157\#else

<a id="l00158" name="l00158"></a> 158 

<a id="l00159" name="l00159"></a> 159\#define ROCKY\_PLUGIN\_PRE\_FORCE\_ON\_FLUID\_END() \\

<a id="l00160" name="l00160"></a> 160 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00161" name="l00161"></a> 161 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(pre\_force, omp)

<a id="l00162" name="l00162"></a> 162 

<a id="l00163" name="l00163"></a> 163\#define ROCKY\_PLUGIN\_POST\_FORCE\_ON\_FLUID\_END() \\

<a id="l00164" name="l00164"></a> 164 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00165" name="l00165"></a> 165 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(post\_force, omp)

<a id="l00166" name="l00166"></a> 166 

<a id="l00167" name="l00167"></a> 167\#define ROCKY\_PLUGIN\_PRE\_MOVE\_ON\_FLUID\_END() \\

<a id="l00168" name="l00168"></a> 168 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00169" name="l00169"></a> 169 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(pre\_move, omp)

<a id="l00170" name="l00170"></a> 170 

<a id="l00171" name="l00171"></a> 171\#define ROCKY\_PLUGIN\_POST\_MOVE\_ON\_FLUID\_END() \\

<a id="l00172" name="l00172"></a> 172 ROCKY\_PLUGIN\_ON\_FLUID\_END() \\

<a id="l00173" name="l00173"></a> 173 ROCKY\_PLUGIN\_ON\_FLUID\_KERNEL(post\_move, omp)

<a id="l00174" name="l00174"></a> 174 

<a id="l00175" name="l00175"></a> 175\#endif

<a id="l00176" name="l00176"></a> 176 

<a id="l00177" name="l00177"></a> 177 

<a id="l00178" name="l00178"></a> 178\#ifndef ROCKY\_CUDA\_API

<a id="l00179" name="l00179"></a> 179 

<a id="l00180" name="l00180"></a> 180// -----------------------------------------------------------------------------------------------

<a id="l00181" name="l00181"></a> 181\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_END() \\

<a id="l00182" name="l00182"></a> 182 ROCKY\_PLUGIN\_CFD\_COUPLING\_KERNEL(omp) \\

<a id="l00183" name="l00183"></a> 183 extern "C" {

<a id="l00184" name="l00184"></a> 184 

<a id="l00185" name="l00185"></a> 185\#else

<a id="l00186" name="l00186"></a> 186 

<a id="l00187" name="l00187"></a> 187// -----------------------------------------------------------------------------------------------

<a id="l00188" name="l00188"></a> 188\#define ROCKY\_PLUGIN\_CFD\_COUPLING\_END() \\

<a id="l00189" name="l00189"></a> 189 ROCKY\_PLUGIN\_CFD\_COUPLING\_KERNEL(omp) \\

<a id="l00190" name="l00190"></a> 190 ROCKY\_PLUGIN\_CFD\_COUPLING\_KERNEL(cuda) \\

<a id="l00191" name="l00191"></a> 191 extern "C" {

<a id="l00192" name="l00192"></a> 192 

<a id="l00193" name="l00193"></a> 193\#endif

[IRockyModel](structIRockyModel.xhtml)

**Definition** rocky_api.h:60