IRockyBreakableParticle Struct Reference
Last update: 08.07.2024
IRockyBreakableParticle Struct Reference
#include <rocky_particle_api.hpp>
Public Member Functions | |
| double | get_minimum_fragment_size () const |
| double | get_original_volume () const |
| int | get_particle_group_index () const |
| double | get_strength () const |
| double | get_original_size () const |
| void | set_as_unbreakable () const |
| IRockyParticleScalars | get_scalars () |
| IRockyParticleBreakageScalars | get_breakage_scalars () |
Detailed Description
IRockyBreakableParticle is an interface for particles enabled to break through instantaneous breakage during a simulation. It may used for the initialization of IRockyParticleBreakageScalars that custom instantaneous breakage and/or fragment size distribution models may need.
Member Function Documentation
◆ get_breakage_scalars()
| IRockyParticleBreakageScalars IRockyBreakableParticle::get_breakage_scalars | ( | ) |
- Returns
- An
IRockyParticleBreakageScalarsobject, that gives access to all particle breakage scalars variables defined in the project.
◆ get_minimum_fragment_size()
| double IRockyBreakableParticle::get_minimum_fragment_size | ( | ) | const |
- Returns
- The minimum size that a fragment generated at a breakage event of the particle can have. Please refer to the DEM Technical Manual for more information about how this parameter is defined.
◆ get_original_size()
| double IRockyBreakableParticle::get_original_size | ( | ) | const |
- Returns
- The value of the particle's size at the moment it enters a simulation.
◆ get_original_volume()
| double IRockyBreakableParticle::get_original_volume | ( | ) | const |
- Returns
- The volume of the particle at the moment it enters a simulation.
◆ get_particle_group_index()
| int IRockyBreakableParticle::get_particle_group_index | ( | ) | const |
- Returns
- The index that identifies internally the particle group to which the particle belongs.
◆ get_scalars()
| IRockyParticleScalars IRockyBreakableParticle::get_scalars | ( | ) |
- Returns
- An
IRockyParticleScalarsobject, that gives access to all particle scalars variables defined in the project.
◆ get_strength()
| double IRockyBreakableParticle::get_strength | ( | ) | const |
- Returns
- A random value between 0 and 1 assigned to a particle at the time of generation. This value can be related to the breakage probability in a custom instantaneous breakage model.
◆ set_as_unbreakable()
| void IRockyBreakableParticle::set_as_unbreakable | ( | ) | const |
- If this method is called during breakage initialization, the particle
- will be marked to be ignored at all instantaneous breakage-related procedures during the simulation.