## On this page

  

 

 # rocky\_sph\_element\_scalars

 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// Includes =======================================================================================

<a id="l00004" name="l00004"></a> 4\#include "../rocky\_scalars.h"

<a id="l00005" name="l00005"></a> 5\#include &lt;rocky20/sph/sph\_particle\_scalars.h&gt;

<a id="l00006" name="l00006"></a> 6 

<a id="l00007" name="l00007"></a> 7using rocky20::KnownSPHParticleScalars;

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

<a id="l00009" name="l00009"></a> 9// Forward declarations ===========================================================================

<a id="l00010" name="l00010"></a> 10class cuda_host;

<a id="l00011" name="l00011"></a> 11struct SPHDeviceModel;

<a id="l00012" name="l00012"></a> 12typedef cuda_host RockyModel;

<a id="l00013" name="l00013"></a> 13 

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

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

<a id="l00016" name="l00016"></a> 16 sphotReset,

<a id="l00017" name="l00017"></a> 17 sphotSum,

<a id="l00018" name="l00018"></a> 18 sphotUpdate

<a id="l00019" name="l00019"></a> 19};

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

<a id="l00028" name="l00028"></a>[ 28](structIRockySPHElementScalarsModel.xhtml)struct [IRockySPHElementScalarsModel](structIRockySPHElementScalarsModel.xhtml) : ScalarsModel&lt;rocky20::SPHParticleScalarsController&gt;

<a id="l00029" name="l00029"></a> 29{

<a id="l00030" name="l00030"></a> 30 // Scalars Operations ------------------------------------------------------------------------

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

<a id="l00081" name="l00081"></a> 81 void [set\_operation](structIRockySPHElementScalarsModel.xhtml#a16f0c80fcfcc46485a0cdb5523eba2bf)(int scalar_index, ESPHOperationType operation, ESPHOperationPlace place);

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

<a id="l00087" name="l00087"></a> 87 void [enable\_velocity\_gradient](structIRockySPHElementScalarsModel.xhtml#ac46511b18b436d5cec83047f8e1e331f)() const;

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

<a id="l00089" name="l00089"></a> 89\#ifdef ONLY\_FOR\_DOXYGEN

<a id="l00090" name="l00090"></a> 90 

<a id="l00092" name="l00092"></a>[ 92](structIRockySPHElementScalarsModel.xhtml#a08368398c992a677000337a1c6b87836) int [find](structIRockySPHElementScalarsModel.xhtml#a08368398c992a677000337a1c6b87836)(const char* name);

<a id="l00093" name="l00093"></a> 93 

<a id="l00095" name="l00095"></a>[ 95](structIRockySPHElementScalarsModel.xhtml#a9ee97eb19ead27e53c0e240f871d09b5) void [reset](structIRockySPHElementScalarsModel.xhtml#a9ee97eb19ead27e53c0e240f871d09b5)(int scalar_index);

<a id="l00096" name="l00096"></a> 96 

<a id="l00098" name="l00098"></a>[ 98](structIRockySPHElementScalarsModel.xhtml#a0dd4ff3f064eea4b4d112155d20aadf1) void [set\_dimension](structIRockySPHElementScalarsModel.xhtml#a0dd4ff3f064eea4b4d112155d20aadf1)(int scalar_index, double dimension_factor);

<a id="l00099" name="l00099"></a> 99 

<a id="l00100" name="l00100"></a> 100\#endif

<a id="l00101" name="l00101"></a> 101 

<a id="l00103" name="l00103"></a> 103 template &lt;class _data_type = float&gt;

<a id="l00104" name="l00104"></a>[ 104](structIRockySPHElementScalarsModel.xhtml#ab522d175868cf8f58efc33f6df21eb07) int [add](structIRockySPHElementScalarsModel.xhtml#ab522d175868cf8f58efc33f6df21eb07)(const char* name, const char* unit, bool output = true)

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

<a id="l00106" name="l00106"></a> 106 // By definition, SPH Scalars are default-typed accumulation for mGPU combine operations.

<a id="l00107" name="l00107"></a> 107 // Although, this is a convention that must be enforced by a set\_operation call indicating

<a id="l00108" name="l00108"></a> 108 // where the accumulation/sum must occur.

<a id="l00109" name="l00109"></a> 109 return this-&gt;_impl.template add_scalars&lt;_data_type&gt;(

<a id="l00110" name="l00110"></a> 110 name, unit, rocky20::ScalarsInfo::cotAccumulateOnDemand, output);

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



<a id="l00112" name="l00112"></a> 112 

<a id="l00115" name="l00115"></a> 115 [IRockySPHElementScalarsModel](structIRockySPHElementScalarsModel.xhtml)(SPHModel* sph_model, const std::vector&lt;int&gt;&amp; device_ids);

<a id="l00116" name="l00116"></a> 116 

<a id="l00118" name="l00118"></a> 118};



<a id="l00119" name="l00119"></a> 119 

<a id="l00126" name="l00126"></a>[ 126](structIRockySPHElementScalars.xhtml)struct [IRockySPHElementScalars](structIRockySPHElementScalars.xhtml) : EntityScalars&lt;rocky20::SPHParticleScalars&gt;

<a id="l00127" name="l00127"></a> 127{

<a id="l00129" name="l00129"></a> 129 using base_type = EntityScalars&lt;rocky20::SPHParticleScalars&gt;;

<a id="l00132" name="l00132"></a> 132 // get ----------------------------------------------------------------------------------------

<a id="l00133" name="l00133"></a> 133 

<a id="l00135" name="l00135"></a> 135 template &lt;class _data_type = float&gt;

<a id="l00136" name="l00136"></a>[ 136](structIRockySPHElementScalars.xhtml#acf45b1ddd0d68df837ec264d2758693f) ROCKY_FUNCTIONS _data_type [get\_scalar](structIRockySPHElementScalars.xhtml#acf45b1ddd0d68df837ec264d2758693f)(int scalar_index) const

<a id="l00137" name="l00137"></a> 137 {

<a id="l00138" name="l00138"></a> 138 return base_type::get_scalar&lt;_data_type&gt;(scalar_index);

<a id="l00139" name="l00139"></a> 139 }



<a id="l00140" name="l00140"></a> 140 

<a id="l00146" name="l00146"></a>[ 146](structIRockySPHElementScalars.xhtml#af70cf6bb3041f4c5e9a8c336ea47b201) ROCKY_FUNCTIONS inline float [get\_turbulent\_viscosity](structIRockySPHElementScalars.xhtml#af70cf6bb3041f4c5e9a8c336ea47b201)() const

<a id="l00147" name="l00147"></a> 147 {

<a id="l00148" name="l00148"></a> 148 return this-&gt;get_known_scalar&lt;float&gt;(KnownSPHParticleScalars::TurbulentViscosity);

<a id="l00149" name="l00149"></a> 149 }



<a id="l00150" name="l00150"></a> 150 

<a id="l00156" name="l00156"></a>[ 156](structIRockySPHElementScalars.xhtml#aa7d031c763a7c8c643ec7a86c07ae6d3) ROCKY_FUNCTIONS inline float [get\_temperature](structIRockySPHElementScalars.xhtml#aa7d031c763a7c8c643ec7a86c07ae6d3)() const

<a id="l00157" name="l00157"></a> 157 {

<a id="l00158" name="l00158"></a> 158 return this-&gt;get_known_scalar&lt;float&gt;(KnownSPHParticleScalars::Temperature);

<a id="l00159" name="l00159"></a> 159 }



<a id="l00160" name="l00160"></a> 160 

<a id="l00166" name="l00166"></a>[ 166](structIRockySPHElementScalars.xhtml#a8a1580996da5f171f535de7e7487fe01) ROCKY_FUNCTIONS inline float [get\_heat\_transfer](structIRockySPHElementScalars.xhtml#a8a1580996da5f171f535de7e7487fe01)() const

<a id="l00167" name="l00167"></a> 167 {

<a id="l00168" name="l00168"></a> 168 return this-&gt;get_known_scalar&lt;float&gt;(KnownSPHParticleScalars::HeatTransferRate);

<a id="l00169" name="l00169"></a> 169 }



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

<a id="l00177" name="l00177"></a>[ 177](structIRockySPHElementScalars.xhtml#a21d991fe945a35f8c7a1f4dffd7c5fe4) ROCKY_FUNCTIONS inline float3 [get\_velocity\_gradient\_x](structIRockySPHElementScalars.xhtml#a21d991fe945a35f8c7a1f4dffd7c5fe4)() const

<a id="l00178" name="l00178"></a> 178 {

<a id="l00179" name="l00179"></a> 179 return this-&gt;get_known_scalar&lt;float3&gt;(KnownSPHParticleScalars::GradientVelocityX);

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



<a id="l00181" name="l00181"></a> 181 

<a id="l00188" name="l00188"></a>[ 188](structIRockySPHElementScalars.xhtml#a0b6e39222f53c9977ed3cdcf74cb4a9f) ROCKY_FUNCTIONS inline float3 [get\_velocity\_gradient\_y](structIRockySPHElementScalars.xhtml#a0b6e39222f53c9977ed3cdcf74cb4a9f)() const

<a id="l00189" name="l00189"></a> 189 {

<a id="l00190" name="l00190"></a> 190 return this-&gt;get_known_scalar&lt;float3&gt;(KnownSPHParticleScalars::GradientVelocityY);

<a id="l00191" name="l00191"></a> 191 }



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

<a id="l00199" name="l00199"></a>[ 199](structIRockySPHElementScalars.xhtml#ace9533abcbc59ad7581a97d988d4c880) ROCKY_FUNCTIONS inline float3 [get\_velocity\_gradient\_z](structIRockySPHElementScalars.xhtml#ace9533abcbc59ad7581a97d988d4c880)() const

<a id="l00200" name="l00200"></a> 200 {

<a id="l00201" name="l00201"></a> 201 return this-&gt;get_known_scalar&lt;float3&gt;(KnownSPHParticleScalars::GradientVelocityZ);

<a id="l00202" name="l00202"></a> 202 }



<a id="l00203" name="l00203"></a> 203 

<a id="l00204" name="l00204"></a> 204 // set ----------------------------------------------------------------------------------------

<a id="l00205" name="l00205"></a> 205 

<a id="l00207" name="l00207"></a> 207 template &lt;class _data_type = float&gt;

<a id="l00208" name="l00208"></a>[ 208](structIRockySPHElementScalars.xhtml#a5dae91ede893e406367059aae00764d5) ROCKY_FUNCTIONS void [set\_scalar](structIRockySPHElementScalars.xhtml#a5dae91ede893e406367059aae00764d5)(int scalar_index, _data_type value) const

<a id="l00209" name="l00209"></a> 209 {

<a id="l00210" name="l00210"></a> 210 base_type::set_scalar&lt;_data_type&gt;(scalar_index, value);

<a id="l00211" name="l00211"></a> 211 }



<a id="l00212" name="l00212"></a> 212 

<a id="l00219" name="l00219"></a>[ 219](structIRockySPHElementScalars.xhtml#aebb2bc65cb47b22517249ce65c8728a8) ROCKY_FUNCTIONS inline void [set\_turbulent\_viscosity](structIRockySPHElementScalars.xhtml#aebb2bc65cb47b22517249ce65c8728a8)(const float value)

<a id="l00220" name="l00220"></a> 220 {

<a id="l00221" name="l00221"></a> 221 this-&gt;get_known_scalar&lt;float&gt;(KnownSPHParticleScalars::TurbulentViscosity) = value;

<a id="l00222" name="l00222"></a> 222 }



<a id="l00223" name="l00223"></a> 223 

<a id="l00230" name="l00230"></a>[ 230](structIRockySPHElementScalars.xhtml#aa04f956ddd857b6b6fd7e2a6fe44a494) ROCKY_FUNCTIONS inline void [set\_temperature](structIRockySPHElementScalars.xhtml#aa04f956ddd857b6b6fd7e2a6fe44a494)(const float value)

<a id="l00231" name="l00231"></a> 231 {

<a id="l00232" name="l00232"></a> 232 this-&gt;get_known_scalar&lt;float&gt;(KnownSPHParticleScalars::Temperature) = value;

<a id="l00233" name="l00233"></a> 233 }



<a id="l00234" name="l00234"></a> 234 

<a id="l00241" name="l00241"></a>[ 241](structIRockySPHElementScalars.xhtml#af40e66b6c4bbea654f110c9d42b3a72f) ROCKY_FUNCTIONS inline void [set\_heat\_transfer](structIRockySPHElementScalars.xhtml#af40e66b6c4bbea654f110c9d42b3a72f)(const float value)

<a id="l00242" name="l00242"></a> 242 {

<a id="l00243" name="l00243"></a> 243 this-&gt;get_known_scalar&lt;float&gt;(KnownSPHParticleScalars::HeatTransferRate) = value;

<a id="l00244" name="l00244"></a> 244 }



<a id="l00245" name="l00245"></a> 245 

<a id="l00246" name="l00246"></a> 246 // add ----------------------------------------------------------------------------------------

<a id="l00247" name="l00247"></a> 247 

<a id="l00249" name="l00249"></a> 249 template &lt;class _data_type = float&gt;

<a id="l00250" name="l00250"></a>[ 250](structIRockySPHElementScalars.xhtml#a72d99d6c1f69b32a5e9e77325974b1f1) ROCKY_FUNCTIONS void [add\_scalar](structIRockySPHElementScalars.xhtml#a72d99d6c1f69b32a5e9e77325974b1f1)(int scalar_index, _data_type value) const

<a id="l00251" name="l00251"></a> 251 {

<a id="l00252" name="l00252"></a> 252 base_type::add_scalar&lt;_data_type&gt;(scalar_index, value);

<a id="l00253" name="l00253"></a> 253 }



<a id="l00254" name="l00254"></a> 254 

<a id="l00260" name="l00260"></a>[ 260](structIRockySPHElementScalars.xhtml#a22c42af1b9c839d1693a42ac889a09df) ROCKY_FUNCTIONS inline void [add\_turbulent\_viscosity](structIRockySPHElementScalars.xhtml#a22c42af1b9c839d1693a42ac889a09df)(const float value)

<a id="l00261" name="l00261"></a> 261 {

<a id="l00262" name="l00262"></a> 262 this-&gt;add_known_scalar(KnownSPHParticleScalars::TurbulentViscosity, value);

<a id="l00263" name="l00263"></a> 263 }



<a id="l00264" name="l00264"></a> 264 

<a id="l00270" name="l00270"></a>[ 270](structIRockySPHElementScalars.xhtml#ae6f55ad8e1a6915cccbade3f199315a4) ROCKY_FUNCTIONS inline void [add\_temperature](structIRockySPHElementScalars.xhtml#ae6f55ad8e1a6915cccbade3f199315a4)(const float value)

<a id="l00271" name="l00271"></a> 271 {

<a id="l00272" name="l00272"></a> 272 this-&gt;add_known_scalar(KnownSPHParticleScalars::Temperature, value);

<a id="l00273" name="l00273"></a> 273 }



<a id="l00274" name="l00274"></a> 274 

<a id="l00282" name="l00282"></a>[ 282](structIRockySPHElementScalars.xhtml#ace6ee0291cca05f39eb04ba4c760afe0) ROCKY_FUNCTIONS inline void [add\_heat\_transfer](structIRockySPHElementScalars.xhtml#ace6ee0291cca05f39eb04ba4c760afe0)(const float value)

<a id="l00283" name="l00283"></a> 283 {

<a id="l00284" name="l00284"></a> 284 this-&gt;add_known_scalar(KnownSPHParticleScalars::HeatTransferRate, value);

<a id="l00285" name="l00285"></a> 285 }



<a id="l00286" name="l00286"></a> 286 

<a id="l00287" name="l00287"></a> 287 // max ----------------------------------------------------------------------------------------

<a id="l00288" name="l00288"></a> 288 

<a id="l00290" name="l00290"></a> 290 template &lt;class _data_type = float&gt;

<a id="l00291" name="l00291"></a>[ 291](structIRockySPHElementScalars.xhtml#af020615c90124b8fe6d7168e964515b6) ROCKY_FUNCTIONS void [max\_scalar](structIRockySPHElementScalars.xhtml#af020615c90124b8fe6d7168e964515b6)(int scalar_index, _data_type value) const

<a id="l00292" name="l00292"></a> 292 {

<a id="l00293" name="l00293"></a> 293 base_type::max_scalar&lt;_data_type&gt;(scalar_index, value);

<a id="l00294" name="l00294"></a> 294 }



<a id="l00295" name="l00295"></a> 295 

<a id="l00298" name="l00298"></a> 298 ROCKY_FUNCTIONS [IRockySPHElementScalars](structIRockySPHElementScalars.xhtml)(

<a id="l00299" name="l00299"></a> 299 rocky20::SPHParticleScalars&amp; _scalars, int _element_index)

<a id="l00300" name="l00300"></a> 300 : EntityScalars&lt;rocky20::SPHParticleScalars&gt;(_scalars, _element_index)

<a id="l00301" name="l00301"></a> 301 {

<a id="l00302" name="l00302"></a> 302 }

<a id="l00303" name="l00303"></a> 303 

<a id="l00305" name="l00305"></a> 305};



[IRockySPHElementScalarsModel](structIRockySPHElementScalarsModel.xhtml)

**Definition** rocky_sph_element_scalars.hpp:29



[IRockySPHElementScalarsModel::find](structIRockySPHElementScalarsModel.xhtml#a08368398c992a677000337a1c6b87836)

int find(const char *name)



[IRockySPHElementScalarsModel::set\_dimension](structIRockySPHElementScalarsModel.xhtml#a0dd4ff3f064eea4b4d112155d20aadf1)

void set_dimension(int scalar_index, double dimension_factor)



[IRockySPHElementScalarsModel::set\_operation](structIRockySPHElementScalarsModel.xhtml#a16f0c80fcfcc46485a0cdb5523eba2bf)

void set_operation(int scalar_index, ESPHOperationType operation, ESPHOperationPlace place)

**Definition** rocky_sph_element_scalars.cpp:11



[IRockySPHElementScalarsModel::reset](structIRockySPHElementScalarsModel.xhtml#a9ee97eb19ead27e53c0e240f871d09b5)

void reset(int scalar_index)



[IRockySPHElementScalarsModel::add](structIRockySPHElementScalarsModel.xhtml#ab522d175868cf8f58efc33f6df21eb07)

int add(const char *name, const char *unit, bool output=true)

**Definition** rocky_sph_element_scalars.hpp:104



[IRockySPHElementScalarsModel::enable\_velocity\_gradient](structIRockySPHElementScalarsModel.xhtml#ac46511b18b436d5cec83047f8e1e331f)

void enable_velocity_gradient() const

**Definition** rocky_sph_element_scalars.cpp:31



[IRockySPHElementScalars](structIRockySPHElementScalars.xhtml)

**Definition** rocky_sph_element_scalars.hpp:127



[IRockySPHElementScalars::get\_velocity\_gradient\_y](structIRockySPHElementScalars.xhtml#a0b6e39222f53c9977ed3cdcf74cb4a9f)

ROCKY_FUNCTIONS float3 get_velocity_gradient_y() const

**Definition** rocky_sph_element_scalars.hpp:188



[IRockySPHElementScalars::get\_velocity\_gradient\_x](structIRockySPHElementScalars.xhtml#a21d991fe945a35f8c7a1f4dffd7c5fe4)

ROCKY_FUNCTIONS float3 get_velocity_gradient_x() const

**Definition** rocky_sph_element_scalars.hpp:177



[IRockySPHElementScalars::add\_turbulent\_viscosity](structIRockySPHElementScalars.xhtml#a22c42af1b9c839d1693a42ac889a09df)

ROCKY_FUNCTIONS void add_turbulent_viscosity(const float value)

**Definition** rocky_sph_element_scalars.hpp:260



[IRockySPHElementScalars::set\_scalar](structIRockySPHElementScalars.xhtml#a5dae91ede893e406367059aae00764d5)

ROCKY_FUNCTIONS void set_scalar(int scalar_index, _data_type value) const

**Definition** rocky_sph_element_scalars.hpp:208



[IRockySPHElementScalars::add\_scalar](structIRockySPHElementScalars.xhtml#a72d99d6c1f69b32a5e9e77325974b1f1)

ROCKY_FUNCTIONS void add_scalar(int scalar_index, _data_type value) const

**Definition** rocky_sph_element_scalars.hpp:250



[IRockySPHElementScalars::get\_heat\_transfer](structIRockySPHElementScalars.xhtml#a8a1580996da5f171f535de7e7487fe01)

ROCKY_FUNCTIONS float get_heat_transfer() const

**Definition** rocky_sph_element_scalars.hpp:166



[IRockySPHElementScalars::set\_temperature](structIRockySPHElementScalars.xhtml#aa04f956ddd857b6b6fd7e2a6fe44a494)

ROCKY_FUNCTIONS void set_temperature(const float value)

**Definition** rocky_sph_element_scalars.hpp:230



[IRockySPHElementScalars::get\_temperature](structIRockySPHElementScalars.xhtml#aa7d031c763a7c8c643ec7a86c07ae6d3)

ROCKY_FUNCTIONS float get_temperature() const

**Definition** rocky_sph_element_scalars.hpp:156



[IRockySPHElementScalars::add\_heat\_transfer](structIRockySPHElementScalars.xhtml#ace6ee0291cca05f39eb04ba4c760afe0)

ROCKY_FUNCTIONS void add_heat_transfer(const float value)

**Definition** rocky_sph_element_scalars.hpp:282



[IRockySPHElementScalars::get\_velocity\_gradient\_z](structIRockySPHElementScalars.xhtml#ace9533abcbc59ad7581a97d988d4c880)

ROCKY_FUNCTIONS float3 get_velocity_gradient_z() const

**Definition** rocky_sph_element_scalars.hpp:199



[IRockySPHElementScalars::get\_scalar](structIRockySPHElementScalars.xhtml#acf45b1ddd0d68df837ec264d2758693f)

ROCKY_FUNCTIONS _data_type get_scalar(int scalar_index) const

**Definition** rocky_sph_element_scalars.hpp:136



[IRockySPHElementScalars::add\_temperature](structIRockySPHElementScalars.xhtml#ae6f55ad8e1a6915cccbade3f199315a4)

ROCKY_FUNCTIONS void add_temperature(const float value)

**Definition** rocky_sph_element_scalars.hpp:270



[IRockySPHElementScalars::set\_turbulent\_viscosity](structIRockySPHElementScalars.xhtml#aebb2bc65cb47b22517249ce65c8728a8)

ROCKY_FUNCTIONS void set_turbulent_viscosity(const float value)

**Definition** rocky_sph_element_scalars.hpp:219



[IRockySPHElementScalars::max\_scalar](structIRockySPHElementScalars.xhtml#af020615c90124b8fe6d7168e964515b6)

ROCKY_FUNCTIONS void max_scalar(int scalar_index, _data_type value) const

**Definition** rocky_sph_element_scalars.hpp:291



[IRockySPHElementScalars::set\_heat\_transfer](structIRockySPHElementScalars.xhtml#af40e66b6c4bbea654f110c9d42b3a72f)

ROCKY_FUNCTIONS void set_heat_transfer(const float value)

**Definition** rocky_sph_element_scalars.hpp:241



[IRockySPHElementScalars::get\_turbulent\_viscosity](structIRockySPHElementScalars.xhtml#af70cf6bb3041f4c5e9a8c336ea47b201)

ROCKY_FUNCTIONS float get_turbulent_viscosity() const

**Definition** rocky_sph_element_scalars.hpp:146