## On this page

  

 

 # rocky\_contact\_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 

<a id="l00006" name="l00006"></a> 6using rocky20::KnownContactScalars;

<a id="l00007" name="l00007"></a> 7 

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

<a id="l00009" name="l00009"></a> 9// IRockyContactScalarsModel

<a id="l00010" name="l00010"></a> 10// =================================================================================================

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

<a id="l00019" name="l00019"></a>[ 19](structIRockyContactScalarsModel.xhtml)struct [IRockyContactScalarsModel](structIRockyContactScalarsModel.xhtml) : ScalarsModel&lt;rocky20::BaseContactScalarsController&gt;

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

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

<a id="l00022" name="l00022"></a> 22\#ifdef ONLY\_FOR\_DOXYGEN

<a id="l00023" name="l00023"></a> 23 

<a id="l00034" name="l00034"></a>[ 34](structIRockyContactScalarsModel.xhtml#ad35ceabceb6ec8d839a3e89086643f99) int [find](structIRockyContactScalarsModel.xhtml#ad35ceabceb6ec8d839a3e89086643f99)(const char* name);

<a id="l00035" name="l00035"></a> 35 

<a id="l00042" name="l00042"></a>[ 42](structIRockyContactScalarsModel.xhtml#a5066c63ea6e2b3b4791f4812b206a65f) void [reset](structIRockyContactScalarsModel.xhtml#a5066c63ea6e2b3b4791f4812b206a65f)(int scalar_index);

<a id="l00043" name="l00043"></a> 43 

<a id="l00058" name="l00058"></a>[ 58](structIRockyContactScalarsModel.xhtml#a95938d3b140e2fbf6b3f417ad88cefd8) void [set\_dimension](structIRockyContactScalarsModel.xhtml#a95938d3b140e2fbf6b3f417ad88cefd8)(int scalar_index, double dimension_factor);

<a id="l00059" name="l00059"></a> 59 

<a id="l00079" name="l00079"></a> 79 int [add](structIRockyContactScalarsModel.xhtml#a00693cfaa879794cda713e943549644f)(const char* name, const char* unit, bool output = true);

<a id="l00080" name="l00080"></a> 80 

<a id="l00100" name="l00100"></a> 100 template&lt;class data_type&gt;

<a id="l00101" name="l00101"></a>[ 101](structIRockyContactScalarsModel.xhtml#a295989b18e690130d92c31881a61ba76) int [add](structIRockyContactScalarsModel.xhtml#a295989b18e690130d92c31881a61ba76)(const char* name, const char* unit, bool output);

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

<a id="l00103" name="l00103"></a> 103\#endif 

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

<a id="l00112" name="l00112"></a> 112 void [enable\_variable\_dynamic\_friction\_coefficient](structIRockyContactScalarsModel.xhtml#afd6b2a12584b9aca0884eef45b372e1c)();

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

<a id="l00121" name="l00121"></a> 121 void [enable\_variable\_static\_friction\_coefficient](structIRockyContactScalarsModel.xhtml#a3a8d067f500bb3b7d39f1cb96f993f78)();

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

<a id="l00130" name="l00130"></a> 130 void [enable\_variable\_restitution\_coefficient](structIRockyContactScalarsModel.xhtml#a7c098d6a1bb42017f323521a267459bd)();

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

<a id="l00140" name="l00140"></a> 140 void [enable\_storage\_sliding\_distance](structIRockyContactScalarsModel.xhtml#a8e8fb75a47341a734ee04707a58f658f)();

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

<a id="l00149" name="l00149"></a> 149 void [enable\_storage\_is\_sliding\_marker](structIRockyContactScalarsModel.xhtml#a2a383fbe3de38c7aab855c0b775a293b)();

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

<a id="l00161" name="l00161"></a> 161 void [enable\_storage\_tangential\_contact\_force](structIRockyContactScalarsModel.xhtml#a5a65f842ce3bea36ee46b346a2741911)();

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

<a id="l00172" name="l00172"></a> 172 void [enable\_storage\_normal\_relative\_velocity](structIRockyContactScalarsModel.xhtml#a30a72264168db13de798df7cdff440c5)();

<a id="l00173" name="l00173"></a> 173 

<a id="l00183" name="l00183"></a> 183 void [enable\_storage\_tangential\_relative\_velocity](structIRockyContactScalarsModel.xhtml#ad8ba6db25bce594fbb62b415b0634a95)();

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

<a id="l00192" name="l00192"></a> 192 void [enable\_storage\_normal\_adhesion\_force](structIRockyContactScalarsModel.xhtml#a0b773628077520e21f189ab64b8b1e69)();

<a id="l00193" name="l00193"></a> 193 

<a id="l00203" name="l00203"></a> 203 void [enable\_storage\_tangential\_adhesion\_force](structIRockyContactScalarsModel.xhtml#ab390c75dee689878d04d1db89be3fb95)();

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

<a id="l00217" name="l00217"></a> 217 void [enable\_storage\_previous\_normal\_vector](structIRockyContactScalarsModel.xhtml#a36a468305e9a49ba36de61846260c1f1)();

<a id="l00218" name="l00218"></a> 218 

<a id="l00229" name="l00229"></a> 229 void [enable\_previous\_moment\_vector](structIRockyContactScalarsModel.xhtml#ab2927b1c13fc4325a5bd28ba97e15230)();

<a id="l00230" name="l00230"></a> 230 

<a id="l00247" name="l00247"></a> 247 void [mark\_scalar\_as\_history\_dependent](structIRockyContactScalarsModel.xhtml#a29e181ff7eef3349c42038e6b7f9541a)(int scalar_index);

<a id="l00248" name="l00248"></a> 248 

<a id="l00250" name="l00250"></a> 250 [IRockyContactScalarsModel](structIRockyContactScalarsModel.xhtml)(RockyModel* solver_model, bool is_particle_contact);

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

<a id="l00252" name="l00252"></a> 252 int [add](structIRockyContactScalarsModel.xhtml#a00693cfaa879794cda713e943549644f)(const char *_name, const char *_unit, bool _output = true);

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

<a id="l00254" name="l00254"></a> 254 template&lt;class _data_type&gt;

<a id="l00255" name="l00255"></a> 255 int [add](structIRockyContactScalarsModel.xhtml#a00693cfaa879794cda713e943549644f)(const char* _name, const char* _unit, bool _output)

<a id="l00256" name="l00256"></a> 256 {

<a id="l00257" name="l00257"></a> 257 auto indexes = this-&gt;_model-&gt;contact_scalars_controller.add_scalars&lt;_data_type&gt;(

<a id="l00258" name="l00258"></a> 258 _name, _unit, this-&gt;_is_particle_contact, !this-&gt;_is_particle_contact, _output);

<a id="l00259" name="l00259"></a> 259 return (this-&gt;_is_particle_contact) ? indexes.first : indexes.second;

<a id="l00260" name="l00260"></a> 260 }

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

<a id="l00262" name="l00262"></a> 262 RockyModel* _model;

<a id="l00263" name="l00263"></a> 263 bool _is_particle_contact;

<a id="l00265" name="l00265"></a> 265};



<a id="l00266" name="l00266"></a> 266 

<a id="l00267" name="l00267"></a> 267// =================================================================================================

<a id="l00268" name="l00268"></a> 268// IRockyContactScalars

<a id="l00269" name="l00269"></a> 269// =================================================================================================

<a id="l00270" name="l00270"></a> 270 

<a id="l00277" name="l00277"></a>[ 277](structIRockyContactScalars.xhtml)struct [IRockyContactScalars](structIRockyContactScalars.xhtml) : EntityScalars&lt;rocky20::ContactScalars&gt;

<a id="l00278" name="l00278"></a> 278{

<a id="l00279" name="l00279"></a> 279 

<a id="l00281" name="l00281"></a> 281 ROCKY_FUNCTIONS [IRockyContactScalars](structIRockyContactScalars.xhtml)(rocky20::ContactScalars&amp; _scalars, int _contact_index)

<a id="l00282" name="l00282"></a> 282 : EntityScalars&lt;rocky20::ContactScalars&gt;(_scalars, _contact_index)

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

<a id="l00286" name="l00286"></a> 286\#ifdef ONLY\_FOR\_DOXYGEN

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

<a id="l00298" name="l00298"></a>[ 298](structIRockyContactScalars.xhtml#ad4f28cca964b58258b7011f0dc59040d) ROCKY_FUNCTIONS double [get\_scalar](structIRockyContactScalars.xhtml#ad4f28cca964b58258b7011f0dc59040d)(int scalar_index) const;

<a id="l00299" name="l00299"></a> 299 

<a id="l00310" name="l00310"></a>[ 310](structIRockyContactScalars.xhtml#abdde96805bdced6ebf4f7c2a1b5d9a70) ROCKY_FUNCTIONS void [set\_scalar](structIRockyContactScalars.xhtml#abdde96805bdced6ebf4f7c2a1b5d9a70)(int scalar_index, double value) const;

<a id="l00311" name="l00311"></a> 311 

<a id="l00322" name="l00322"></a>[ 322](structIRockyContactScalars.xhtml#a67c155eff0d5724c29859512b0d994de) ROCKY_FUNCTIONS void [add\_scalar](structIRockyContactScalars.xhtml#a67c155eff0d5724c29859512b0d994de)(int scalar_index, double value) const;

<a id="l00323" name="l00323"></a> 323 

<a id="l00336" name="l00336"></a>[ 336](structIRockyContactScalars.xhtml#a6413332aeb968cdc28e96a351deb3bcb) ROCKY_FUNCTIONS void [max\_scalar](structIRockyContactScalars.xhtml#a6413332aeb968cdc28e96a351deb3bcb)(int scalar_index, double value) const;

<a id="l00337" name="l00337"></a> 337 

<a id="l00338" name="l00338"></a> 338\#endif

<a id="l00339" name="l00339"></a> 339 

<a id="l00340" name="l00340"></a> 340};



[IRockyContactScalarsModel](structIRockyContactScalarsModel.xhtml)

**Definition** rocky_contact_scalars.hpp:20



[IRockyContactScalarsModel::add](structIRockyContactScalarsModel.xhtml#a00693cfaa879794cda713e943549644f)

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

**Definition** rocky_contact_scalars.cpp:21



[IRockyContactScalarsModel::enable\_storage\_normal\_adhesion\_force](structIRockyContactScalarsModel.xhtml#a0b773628077520e21f189ab64b8b1e69)

void enable_storage_normal_adhesion_force()

**Definition** rocky_contact_scalars.cpp:80



[IRockyContactScalarsModel::add](structIRockyContactScalarsModel.xhtml#a295989b18e690130d92c31881a61ba76)

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



[IRockyContactScalarsModel::mark\_scalar\_as\_history\_dependent](structIRockyContactScalarsModel.xhtml#a29e181ff7eef3349c42038e6b7f9541a)

void mark_scalar_as_history_dependent(int scalar_index)

**Definition** rocky_contact_scalars.cpp:110



[IRockyContactScalarsModel::enable\_storage\_is\_sliding\_marker](structIRockyContactScalarsModel.xhtml#a2a383fbe3de38c7aab855c0b775a293b)

void enable_storage_is_sliding_marker()

**Definition** rocky_contact_scalars.cpp:56



[IRockyContactScalarsModel::enable\_storage\_normal\_relative\_velocity](structIRockyContactScalarsModel.xhtml#a30a72264168db13de798df7cdff440c5)

void enable_storage_normal_relative_velocity()

**Definition** rocky_contact_scalars.cpp:68



[IRockyContactScalarsModel::enable\_storage\_previous\_normal\_vector](structIRockyContactScalarsModel.xhtml#a36a468305e9a49ba36de61846260c1f1)

void enable_storage_previous_normal_vector()

**Definition** rocky_contact_scalars.cpp:92



[IRockyContactScalarsModel::enable\_variable\_static\_friction\_coefficient](structIRockyContactScalarsModel.xhtml#a3a8d067f500bb3b7d39f1cb96f993f78)

void enable_variable_static_friction_coefficient()

**Definition** rocky_contact_scalars.cpp:36



[IRockyContactScalarsModel::reset](structIRockyContactScalarsModel.xhtml#a5066c63ea6e2b3b4791f4812b206a65f)

void reset(int scalar_index)



[IRockyContactScalarsModel::enable\_storage\_tangential\_contact\_force](structIRockyContactScalarsModel.xhtml#a5a65f842ce3bea36ee46b346a2741911)

void enable_storage_tangential_contact_force()

**Definition** rocky_contact_scalars.cpp:62



[IRockyContactScalarsModel::enable\_variable\_restitution\_coefficient](structIRockyContactScalarsModel.xhtml#a7c098d6a1bb42017f323521a267459bd)

void enable_variable_restitution_coefficient()

**Definition** rocky_contact_scalars.cpp:44



[IRockyContactScalarsModel::enable\_storage\_sliding\_distance](structIRockyContactScalarsModel.xhtml#a8e8fb75a47341a734ee04707a58f658f)

void enable_storage_sliding_distance()

**Definition** rocky_contact_scalars.cpp:50



[IRockyContactScalarsModel::set\_dimension](structIRockyContactScalarsModel.xhtml#a95938d3b140e2fbf6b3f417ad88cefd8)

void set_dimension(int scalar_index, double dimension_factor)



[IRockyContactScalarsModel::enable\_previous\_moment\_vector](structIRockyContactScalarsModel.xhtml#ab2927b1c13fc4325a5bd28ba97e15230)

void enable_previous_moment_vector()

**Definition** rocky_contact_scalars.cpp:101



[IRockyContactScalarsModel::enable\_storage\_tangential\_adhesion\_force](structIRockyContactScalarsModel.xhtml#ab390c75dee689878d04d1db89be3fb95)

void enable_storage_tangential_adhesion_force()

**Definition** rocky_contact_scalars.cpp:86



[IRockyContactScalarsModel::find](structIRockyContactScalarsModel.xhtml#ad35ceabceb6ec8d839a3e89086643f99)

int find(const char *name)



[IRockyContactScalarsModel::enable\_storage\_tangential\_relative\_velocity](structIRockyContactScalarsModel.xhtml#ad8ba6db25bce594fbb62b415b0634a95)

void enable_storage_tangential_relative_velocity()

**Definition** rocky_contact_scalars.cpp:74



[IRockyContactScalarsModel::enable\_variable\_dynamic\_friction\_coefficient](structIRockyContactScalarsModel.xhtml#afd6b2a12584b9aca0884eef45b372e1c)

void enable_variable_dynamic_friction_coefficient()

**Definition** rocky_contact_scalars.cpp:28



[IRockyContactScalars](structIRockyContactScalars.xhtml)

**Definition** rocky_contact_scalars.hpp:278



[IRockyContactScalars::max\_scalar](structIRockyContactScalars.xhtml#a6413332aeb968cdc28e96a351deb3bcb)

ROCKY_FUNCTIONS void max_scalar(int scalar_index, double value) const



[IRockyContactScalars::add\_scalar](structIRockyContactScalars.xhtml#a67c155eff0d5724c29859512b0d994de)

ROCKY_FUNCTIONS void add_scalar(int scalar_index, double value) const



[IRockyContactScalars::set\_scalar](structIRockyContactScalars.xhtml#abdde96805bdced6ebf4f7c2a1b5d9a70)

ROCKY_FUNCTIONS void set_scalar(int scalar_index, double value) const



[IRockyContactScalars::get\_scalar](structIRockyContactScalars.xhtml#ad4f28cca964b58258b7011f0dc59040d)

ROCKY_FUNCTIONS double get_scalar(int scalar_index) const