Structure IRockyContactScalars

#include

During the iterative process of a simulation, IRockyContactScalars gives access to all contact scalars defined in the project. These contact scalars can be built-in scalars defined in the Rocky solver, as well as custom contact scalars defined by the current module or other active modules.

Inherits from:

• EntityScalars\ rocky20::ContactScalars >

Members

• add_scalar
• get_scalar
• max_scalar
• set_scalar

Public functions

Function get_scalar

![][const]

ROCKY_FUNCTIONS double IRockyContactScalars::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.

Parameters:

• int scalar_index

Return type: ROCKY_FUNCTIONS double

Function set_scalar

![][const]

ROCKY_FUNCTIONS void IRockyContactScalars::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.

Parameters:

• int scalar_index
• double value

Return type: ROCKY_FUNCTIONS void

Function add_scalar

![][const]

ROCKY_FUNCTIONS void IRockyContactScalars::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.
  

Parameters:

• int scalar_index
• double value

Return type: ROCKY_FUNCTIONS void

Function max_scalar

![][const]

ROCKY_FUNCTIONS void IRockyContactScalars::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.

Parameters:

• int scalar_index
• double value

Return type: ROCKY_FUNCTIONS void

[const]: https://img.shields.io/badge/-const-lightblue (const)