RAUserProcessCollection

class RAUserProcessCollection

Rocky api collection of geometries.

Methods:

CreateContactToParticleProcess(parent[, name])	Creates a new ContactToParticle process using the given parent as input.
CreateCubeProcess(parent[, name, center, ...])	Creates a new cube process using the given parent as input.
CreateCylinderProcess(parent[, name, ...])	Creates a new cube process using the given parent as input.
CreateEulerianStatistics(parent[, name, ...])	Creates a new cube process using the given parent as input.
CreateFilterProcess(parent[, name])	Creates a new filter process using the given parent as input.
CreateInspectorProcess(parent[, name])	Creates a new plane process using the given parent as input.
CreateParticleTimeSelectionProcess(parent[, ...])	Creates a new particle time selection process using the given parent as input.
CreateParticleToContactProcess(parent[, name])	Creates a new ParticleToContact process using the given parent as input.
CreatePlaneProcess(parent[, name, origin, ...])	Creates a new plane process using the given parent as input.
CreatePolyhedronProcess(parent, stl_filename)	Creates a new polyhedron process using the given parent as input.
CreatePropertyProcess(parent[, name])	Deprecated: Use CreateFilterProcess instead.
CreateStreamlinesUserProcess(parent[, name])	Creates a new StreamlinesUserProcess process using the given parent as input.
CreateSurfaceUserProcess(parent, stl_filename)	Creates a new Surface process using the given parent as input.
CreateTrajectoryProcess(parent[, ...])	Create a new Particle Trajectory process.
GetContactToParticleProcessNames()	Get the names of created Contact to Particle processes.
GetCubeProcessNames()	Get the names of created cube processes.
GetCylinderProcessNames()	Get the names of created cylinder processes.
GetEulerianStatisticsNames()	Get the names of created eulerian statistics processes.
GetFilterProcessNames()	Get the names of created property processes.
GetInspectorProcessNames()	Get the names of created inspector processes.
GetParticleTimeSelectionProcessNames()	Get the names of created particle time selection processes.
GetParticleToContactProcessNames()	Get the names of created Particle to Contact processes.
GetPlaneProcessNames()	Get the names of created plane processes.
GetPolyhedronProcessNames()	Get the names of created polyhedron processes.
GetProcess(process_name)	Get a user process given its name.
GetProcessNames()	Get a list with the name of the user processes.
GetPropertyProcessNames()	Deprecated: Use GetFilterProcessNames instead.
GetStreamlinesUserProcessNames()	Get the names of created streamlines processes.
GetSurfaceUserProcessNames()	Get the names of created surfaces processes.
GetTrajectoryProcessNames()	Get the names of created trajectory processes.

CreateContactToParticleProcess(parent, name=None)

Creates a new ContactToParticle process using the given parent as input.

• Parameters:
  • parent (RAGridProcessElementItem) – The new process’ parent
  • name (str *|*None) – The name of the new process or None for default
• Return type: RAContactToParticleProcess
• Returns: A new ContactToParticle process

CreateCubeProcess(parent, name=None, center=None, magnitude=None, rotation=None, parent_pool_id=None)

Creates a new cube process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The cube process parent
  • name (str *|*None) – The name of the new process or None for default
  • center (tuple *(*float , float , float )) – The center X, Y and Z coordinates in meters (m)
  • magnitude – The center X, Y and Z magnitude in meters (m)
  • rotation – The center X, Y and Z rotation in degress (dega)
• Return type: RACubeProcess
• Returns: A new cube process

CreateCylinderProcess(parent, name=None, center=None, size=None, rotation=None, internal_factor=None, initial_angle=None, final_angle=None)

Creates a new cube process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The cube process parent
  • name (str *|*None) – The name of the new process or None for default
  • center (tuple *(*float , float , float )) – The center X, Y and Z coordinates in meters (m)
  • size – The X, Y and Z size in meters (m)
  • rotation – The center X, Y and Z rotation in degress (dega)
  • internal_factor – The internal hole radius factor of the external given by the size in percentage (%)
  • initial_angle – The initial angle in degress (dega)
  • final_angle – The final angle in degress (dega)
• Return type: RACylinderProcess
• Returns: A new cylinder process

CreateEulerianStatistics(parent, name=None, divisions=None)

Creates a new cube process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The process parent. Must be either a cube or a cylinder.
  • name (str *|*None) – The name of the new process or None for default
  • divisions – The number of divisions in i, j and k.
• Return type: RAEulerianStatistics
• Returns: A new Eulerian Statistics process.

CreateFilterProcess(parent, name=None)

Creates a new filter process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The filter process parent
  • name (str *|*None) – The name of the new process or None for default
• Return type: RAFilterProcess
• Returns: A new filter process

CreateInspectorProcess(parent, name=None)

Creates a new plane process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The plane process parent
  • name (str *|*None) – The name of the new process or None for default
• Return type: RAPlaneProcess
• Returns: A new plane process

CreateParticleTimeSelectionProcess(parent, range_definition='absolute', initial=0, final=0, unit='s')

Creates a new particle time selection process using the given parent as input.

• Parameters:
  • parent – Input for the particle time selection.
  • range_definition – One of: ‘app_time_filter’, ‘all’, ‘last_output’, ‘absolute’, ‘single’, ‘absolute_only_start’, ‘relative_to_end’.
  • initial (float) – The initial value for the particle time selection to consider particles. May be ignored depending on the range definition.
  • final (float) – The final time for the particle time selection to consider particles. May be ignored depending on the range definition.
  • unit – The unit for the initial/final values passed.

CreateParticleToContactProcess(parent, name=None)

Creates a new ParticleToContact process using the given parent as input.

• Parameters:
  • parent (RAGridProcessElementItem) – The new process’ parent
  • name (str *|*None) – The name of the new process or None for default
• Return type: RAParticleToContactProcess
• Returns: A new ParticleToContact process

CreatePlaneProcess(parent, name=None, origin=None, normal=None, plane_type=None, plane_mode=None)

Creates a new plane process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The plane process parent
  • name (str *|*None) – The name of the new process or None for default
  • origin (tuple *(*float , float , float )) – The origin X, Y and Z coordinates in meters (m)
  • normal (tuple *(*float , float , float )) – The normal X, Y and Z in meters (m)
• Return type: RAPlaneProcess
• Returns: A new plane process

CreatePolyhedronProcess(parent: ApiElementItem, stl_filename: str, name: str | None = None, import_scale: float = 1.0, convert_yz: bool = False)

Creates a new polyhedron process using the given parent as input.

• Parameters:
  • parent (Grid *|*Process) – The polyhedron process parent.
  • stl_filename (str) – The filename with the stl to be loaded for the polyhedron.
  • name (str *|*None) – The name of the new process or None for default.
  • import_scale (float) – The import scale to be applied on the STL’s geometry when importing.
  • convert_yz (bool) – Whether the Y and Z axes should be swapped on the STL’s geometry when importing.
• Return type: RAPolyhedronProcess
• Returns: A new polyhedron process.

CreatePropertyProcess(parent, name=None)

Deprecated: Use CreateFilterProcess instead.

CreateStreamlinesUserProcess(parent: ApiElementItem, name: str | None = None)

Creates a new StreamlinesUserProcess process using the given parent as input.

• Parameters:
  • parent – The parent process.
  • name – The name of the new process or None for default

CreateSurfaceUserProcess(parent: ApiElementItem, stl_filename: str, name: str | None = None, import_scale: float = 1.0, convert_yz: bool = False)

Creates a new Surface process using the given parent as input.

• Parameters:
  • parent – The surface process parent.
  • stl_filename – The filename with the stl to be loaded for the surface.
  • name – The name of the new process or None for default.
  • import_scale – The import scale to be applied on the STL’s geometry when importing.
  • convert_yz – Whether the Y and Z axes should be swapped on the STL’s geometry when importing.
• Returns: A new surface process.

CreateTrajectoryProcess(parent, starting_timestep=None, number_timesteps=None, particle_stride=None)

Create a new Particle Trajectory process.

• See: RATrajectoryProcess for a explanation of the parameters.
• Return type: RATrajectoryProcess

GetContactToParticleProcessNames()

Get the names of created Contact to Particle processes.

• Returns: The list of Contact to Particle user process names

GetCubeProcessNames()

Get the names of created cube processes.

• Returns: The list of cube user process names

GetCylinderProcessNames()

Get the names of created cylinder processes.

• Returns: The list of cylinder user process names

GetEulerianStatisticsNames()

Get the names of created eulerian statistics processes.

• Returns: The list of eulerian statistics user process names

GetFilterProcessNames()

Get the names of created property processes.

• Returns: The list of property user process names.

GetInspectorProcessNames()

Get the names of created inspector processes.

• Returns: The list of inspector user process names

GetParticleTimeSelectionProcessNames()

Get the names of created particle time selection processes.

• Returns: The list of particle time selection user process names

GetParticleToContactProcessNames()

Get the names of created Particle to Contact processes.

• Returns: The list of Particle to Contact user process names

GetPlaneProcessNames()

Get the names of created plane processes.

• Returns: The list of plane user process names

GetPolyhedronProcessNames()

Get the names of created polyhedron processes.

• Returns: The list of polyhedron user process names.

GetProcess(process_name)

Get a user process given its name.

• Parameters: process_name (unicode)
• Return type: ApiElementItem

GetProcessNames()

Get a list with the name of the user processes.

• Return type: list(unicode)

GetPropertyProcessNames()

Deprecated: Use GetFilterProcessNames instead.

GetStreamlinesUserProcessNames()

Get the names of created streamlines processes.

• Returns: The list of streamlines user process names.

GetSurfaceUserProcessNames()

Get the names of created surfaces processes.

• Returns: The list of surfaces user process names.

GetTrajectoryProcessNames()

Get the names of created trajectory processes.

• Returns: The list of trajectory user process names