## On this page

  

 

 # IRockyParticleBreakageScalars Struct Reference

 Last update: 17.07.2025 

`#include <<a class="el" href="rocky__particle__scalars_8hpp_source.xhtml">rocky_particle_scalars.hpp</a>>`

Inherits EntityScalars&lt; rocky20::ParticleBreakageScalars &gt;.

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

ROCKY\_FUNCTIONS double [get\_t10](structIRockyParticleBreakageScalars.xhtml#af47b2e930c6a25249584df9d3600945b) () const ROCKY\_FUNCTIONS void [set\_t10](structIRockyParticleBreakageScalars.xhtml#afde7cd6ccf288b6e0834357e74344578) (const double value) ROCKY\_FUNCTIONS double [get\_scalar](structIRockyParticleBreakageScalars.xhtml#af101f19299a5a1d5d3da3fe1d2a0f74b) (int scalar\_index) const ROCKY\_FUNCTIONS void [set\_scalar](structIRockyParticleBreakageScalars.xhtml#a71109dbd97b7c53d5a001f6d8c66d66f) (int scalar\_index, double value) const ROCKY\_FUNCTIONS void [add\_scalar](structIRockyParticleBreakageScalars.xhtml#a8c8fe58709bc4dcc7becc23e716483d6) (int scalar\_index, double value) const ROCKY\_FUNCTIONS void [max\_scalar](structIRockyParticleBreakageScalars.xhtml#ad5d957f09f3fc73349741c296f66b7d1) (int scalar\_index, double value) const <a id="details" name="details"></a>## Detailed Description

When running a simulation, an `<a class="el" href="structIRockyParticleBreakageScalars.xhtml">IRockyParticleBreakageScalars</a>` gives access to all particle breakage scalars defined in the project. Particle breakage scalars are special particle scalars which can be used to transfer data from the point where the instantaneous breakage criterion is evaluated (at the `ROCKY_PLUGIN_COMPUTE_INSTANTANEOUS_BREAKAGE` hook) to the point where the fragment size distribution is calculated (at the `ROCKY_PLUGIN_COMPUTE_FRAGMENTS_SIZE_DISTRIBUTION` hook).



## Member Function Documentation

<a id="a8c8fe58709bc4dcc7becc23e716483d6" name="a8c8fe58709bc4dcc7becc23e716483d6"></a>## [◆ ](#a8c8fe58709bc4dcc7becc23e716483d6)add\_scalar()

 ROCKY\_FUNCTIONS void IRockyParticleBreakageScalars::add\_scalar  ( int  *scalar\_index*,    double  *value*   )  const

If a custom scalar variable was defined during the setup of the module,this method can be used to sum a value to the current one stored in it.Parameters scalar\_indexThe integer index that was associated to the scalar variable during the setup of the module.valueThe value that must be summed to the current stored value.  




<a id="af101f19299a5a1d5d3da3fe1d2a0f74b" name="af101f19299a5a1d5d3da3fe1d2a0f74b"></a>## [◆ ](#af101f19299a5a1d5d3da3fe1d2a0f74b)get\_scalar()

 ROCKY\_FUNCTIONS double IRockyParticleBreakageScalars::get\_scalar  ( int  *scalar\_index*)  const

If a custom scalar variable was defined during the setup of the module,the value currently stored can be accessed with this method.Parameters scalar\_indexThe integer index that was associated to the scalar variable during the setup of the module.ReturnsThe value currently stored in the scalar variable. 



<a id="af47b2e930c6a25249584df9d3600945b" name="af47b2e930c6a25249584df9d3600945b"></a>## [◆ ](#af47b2e930c6a25249584df9d3600945b)get\_t10()

 ROCKY\_FUNCTIONS double IRockyParticleBreakageScalars::get\_t10  ( )  const

ReturnsThe value of the \\(t\_{10}\\) parameter set at an instantaneous breakage event. Please refer to the DEM Technical Manual for the definition of this parameter. 



<a id="ad5d957f09f3fc73349741c296f66b7d1" name="ad5d957f09f3fc73349741c296f66b7d1"></a>## [◆ ](#ad5d957f09f3fc73349741c296f66b7d1)max\_scalar()

 ROCKY\_FUNCTIONS void IRockyParticleBreakageScalars::max\_scalar  ( int  *scalar\_index*,    double  *value*   )  const

If a custom scalar variable was defined during the setup of the module,this method can be used to make the scalar store the maximum of a set of values. A common use of this method is, for instance, to find the maximum among a set of values associated to the contacts of a particle.Parameters scalar\_indexThe integer index that was associated to the scalar variable during the setup of the module.valueA value that must be checked if it is greater than the current stored value. 



<a id="a71109dbd97b7c53d5a001f6d8c66d66f" name="a71109dbd97b7c53d5a001f6d8c66d66f"></a>## [◆ ](#a71109dbd97b7c53d5a001f6d8c66d66f)set\_scalar()

 ROCKY\_FUNCTIONS void IRockyParticleBreakageScalars::set\_scalar  ( int  *scalar\_index*,    double  *value*   )  const

If a custom scalar variable was defined during the setup of the module,this method can be used to store a value on it.Parameters scalar\_indexThe integer index that was associated to the scalar variable during the setup of the module.valueThe value that must be stored. 



<a id="afde7cd6ccf288b6e0834357e74344578" name="afde7cd6ccf288b6e0834357e74344578"></a>## [◆ ](#afde7cd6ccf288b6e0834357e74344578)set\_t10()

 ROCKY\_FUNCTIONS void IRockyParticleBreakageScalars::set\_t10  ( const double  *value*) 

This method sets the value of the t10 parameter calculated at an instantaneous breakage event. Please refer to the DEM Technical Manual for the definition of this parameter.Parameters valueThe value of the \\(t\_{10}\\) parameter just calculated.