RACalculations

class ansys.rocky.app.ra_calculations.RACalculations(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky api for particles calculations

Overview

Constructors

GetWrappedClass
GetClassName

Methods

CreateSelectionResidenceTime	Create a residence time grid function for the given selection process
CreateSelectionFlipCount	Create a flip count grid function for the given selection process
GetTagging	Get the Tagging calculator with the given name.
GetDivisionsTagging	Get the Divisions Tagging calculator with the given name.
GetTaggingNames	Get a list of the names of all Taggings in Particles Calculations.
GetDivisionsTaggingNames	Get a list of the names of all Divisions Taggings in Particles Calculations.
CreateTagging	Create a Tagging calculator for the given particle-based selection process.
CreateDivisionsTagging	Create a Divisions Tagging calculator for the given particle-based selection process.

Special methods

__iter__	Iterates over the wrapped particle calculations.
__len__	rtype: int
__getitem__	param index:

Import detail

from ansys.rocky.app.ra_calculations import RACalculations

Method detail

classmethod RACalculations.GetWrappedClass() → type[rocky30.plugins.particles_calculations.particles_calculations.ParticlesCalculations]

classmethod RACalculations.GetClassName() → str

RACalculations.CreateSelectionResidenceTime(selection: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem | str) → rocky30.plugins.particles_calculations.particles_selection_calculator.ParticlesSelectionCalculator

Create a residence time grid function for the given selection process

RACalculations.CreateSelectionFlipCount(selection: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem) → rocky30.plugins.particles_calculations.particles_selection_calculator.ParticlesSelectionCalculator

Create a flip count grid function for the given selection process

RACalculations.GetTagging(name: str) → ansys.rocky.app.ra_tagging.RATagging

Get the Tagging calculator with the given name.

RACalculations.GetDivisionsTagging(name: str) → ansys.rocky.app.ra_divisions_tagging.RADivisionsTagging

Get the Divisions Tagging calculator with the given name.

RACalculations.GetTaggingNames() → list[str]

Get a list of the names of all Taggings in Particles Calculations.

RACalculations.GetDivisionsTaggingNames() → list[str]

Get a list of the names of all Divisions Taggings in Particles Calculations.

RACalculations.CreateTagging(selection: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem) → rocky30.plugins.particles_calculations.particles_selection_calculator.ParticlesSelectionCalculator | None

Create a Tagging calculator for the given particle-based selection process.

Parameters:

selection – Must be a particle selection type.

RACalculations.CreateDivisionsTagging(selection: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem) → ansys.rocky.app.ra_divisions_tagging.RADivisionsTagging

Create a Divisions Tagging calculator for the given particle-based selection process.

Parameters:

selection – Must be a particle selection type.

RACalculations.__iter__() → collections.abc.Iterator

Iterates over the wrapped particle calculations.

RACalculations.__len__() → int

Return type:

int

Returns:

The number of particle calculations

RACalculations.__getitem__(index: int) → rocky30.plugins.particles_calculations.particles_selection_calculator.ParticlesSelectionCalculator

Parameters:

index – The calculation index

Returns:

The particle calculation at the given index