IRockyPairScalars Struct Reference
Last update: 08.07.2024
IRockyPairScalars Struct Reference
#include <rocky_pair_scalars.hpp>
Inherits EntityScalars< rocky20::PairScalars >.
Public Member Functions | |
| ROCKY_FUNCTIONS double | get_scalar (int scalar_index) const |
| ROCKY_FUNCTIONS void | set_scalar (int scalar_index, double value) const |
| ROCKY_FUNCTIONS void | add_scalar (int scalar_index, double value) const |
| ROCKY_FUNCTIONS void | max_scalar (int scalar_index, double value) const |
Detailed Description
When running a simulation, an IRockyPairScalars gives access to all pair scalars defined in the project. Pair scalars are special variables with a value attached to every combination of two particle groups and with each combination of a particle group and a geometry.
Member Function Documentation
◆ add_scalar()
| ROCKY_FUNCTIONS void IRockyPairScalars::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_index The integer index that was associated to the scalar variable during the setup of the module. value The value that must be summed to the current stored value.
◆ get_scalar()
| ROCKY_FUNCTIONS double IRockyPairScalars::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_index The integer index that was associated to the scalar variable during the setup of the module.
- Returns
- The value currently stored in the scalar variable.
◆ max_scalar()
| ROCKY_FUNCTIONS void IRockyPairScalars::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_index The integer index that was associated to the scalar variable during the setup of the module. value A value that must be checked if it is greater than the current stored value.
◆ set_scalar()
| ROCKY_FUNCTIONS void IRockyPairScalars::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_index The integer index that was associated to the scalar variable during the setup of the module. value The value that must be stored.