IRockyParticleTransferScalars Struct Reference
Last update: 08.07.2024
IRockyParticleTransferScalars Struct Reference
#include <rocky_particle_scalars.hpp>
Inherits EntityScalars< rocky20::ParticleTransferScalars >.
Public Member Functions | |
| ROCKY_FUNCTIONS double | get_heat_transfer () const |
| ROCKY_FUNCTIONS void | set_heat_transfer (const double value) |
| ROCKY_FUNCTIONS void | add_heat_transfer (const double value) |
| ROCKY_FUNCTIONS void | add_heat_source (const double value) |
| 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 IRockyParticleTransferScalars gives access to all particle transfer scalars defined in the project. Particle transfer scalars are special particle scalars whose values are reset automatically to zero at the beginning of a new time iteration.
Member Function Documentation
◆ add_heat_source()
| ROCKY_FUNCTIONS void IRockyParticleTransferScalars::add_heat_source | ( | const double | value | ) |
- This method adds a value to the source term to the thermal energy balance
- equation of a particle. The added value can be positive (heat is generated) or negative (heat is removed).
- Parameters
-
value The value of the thermal energy per unit time generated in or removed from the particle.
◆ add_heat_transfer()
| ROCKY_FUNCTIONS void IRockyParticleTransferScalars::add_heat_transfer | ( | const double | value | ) |
- This method sums a value to the current heat transfer rate to the particle.
- Parameters
-
value The value summed to the heat transfer rate.
◆ add_scalar()
| ROCKY_FUNCTIONS void IRockyParticleTransferScalars::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_heat_transfer()
| ROCKY_FUNCTIONS double IRockyParticleTransferScalars::get_heat_transfer | ( | ) | const |
- Returns
- The value of the total heat transfer rate to the particle at a given time. This is a built-in particle scalar defined inside the solver, enabled whenever a thermal model is active in the project.
◆ get_scalar()
| ROCKY_FUNCTIONS double IRockyParticleTransferScalars::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 IRockyParticleTransferScalars::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_heat_transfer()
| ROCKY_FUNCTIONS void IRockyParticleTransferScalars::set_heat_transfer | ( | const double | value | ) |
- This method sets the value of the heat transfer rate to the particle. This value
- will be used in the thermal energy balance equation of the particle in order to update its temperature at the following timestep.
- Parameters
-
value The value of the heat transfer rate.
◆ set_scalar()
| ROCKY_FUNCTIONS void IRockyParticleTransferScalars::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.