RAUserProcessCollection

class ansys.rocky.app.ra_user_process_collection.RAUserProcessCollection(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky api collection of geometries.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

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

Import detail

from ansys.rocky.app.ra_user_process_collection import RAUserProcessCollection

Method detail

classmethod RAUserProcessCollection.GetWrappedClass()

classmethod RAUserProcessCollection.GetClassName()

RAUserProcessCollection.GetProcessNames()

Get a list with the name of the user processes.

Return type:

list(unicode)

RAUserProcessCollection.GetProcess(process_name)

Get a user process given its name.

Parameters:

process_name (unicode)

Return type:

ApiElementItem

RAUserProcessCollection.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

RAUserProcessCollection.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

RAUserProcessCollection.GetPlaneProcessNames()

Get the names of created plane processes.

Returns:

The list of plane user process names

RAUserProcessCollection.GetInspectorProcessNames()

Get the names of created inspector processes.

Returns:

The list of inspector user process names

RAUserProcessCollection.CreatePlaneGroupProcess(parent_processes: list[ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem] | ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem, name: str | None = None, plane_origin_fixed_array: coilib50.units.mapped_io.FixedArray | None = None, mode: str | None = None, type: str | None = None) → ansys.rocky.app.ra_process_element.RAPlaneGroup

RAUserProcessCollection.CreateCylinderGroupProcess(parent_processes, name=None, center: rocky30.base_types.Tuple3F | None = None, size: rocky30.base_types.Tuple3F | None = None, rotation: rocky30.base_types.Tuple3F | None = None, internal_factor=None, initial_angle=None, final_angle=None) → ansys.rocky.app.ra_process_element.RACylinderGroup

RAUserProcessCollection.CreateCubeGroupProcess(parent_processes, name: str | None = None, center: rocky30.base_types.Tuple3F | None = None, magnitude: rocky30.base_types.Tuple3F | None = None, rotation: rocky30.base_types.Tuple3F | None = None) → ansys.rocky.app.ra_process_element.RACubeGroup

RAUserProcessCollection.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

RAUserProcessCollection.GetCubeProcessNames()

Get the names of created cube processes.

Returns:

The list of cube user process names

RAUserProcessCollection.GetTrajectoryProcessNames()

Get the names of created trajectory processes.

Returns:

The list of trajectory user process names

RAUserProcessCollection.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

RAUserProcessCollection.CreateParticleTimeSelectionProcess(parent, range_definition: str = 'absolute', initial: int = 0, final: int = 0, unit: str = '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.

RAUserProcessCollection.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

RAUserProcessCollection.GetCylinderProcessNames()

Get the names of created cylinder processes.

Returns:

The list of cylinder user process names

RAUserProcessCollection.GetParticleTimeSelectionProcessNames()

Get the names of created particle time selection processes.

Returns:

The list of particle time selection user process names

RAUserProcessCollection.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.

RAUserProcessCollection.GetEulerianStatisticsNames()

Get the names of created eulerian statistics processes.

Returns:

The list of eulerian statistics user process names

RAUserProcessCollection.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

RAUserProcessCollection.CreatePropertyProcess(parent, name=None)

Deprecated: Use CreateFilterProcess instead.

RAUserProcessCollection.GetFilterProcessNames()

Get the names of created property processes.

Returns:

The list of property user process names.

RAUserProcessCollection.GetPropertyProcessNames()

Deprecated: Use GetFilterProcessNames instead.

RAUserProcessCollection.CreatePolyhedronProcess(parent: ansys.rocky.app.api_element_item.ApiElementItem, stl_filename: str, name: str | None = None, import_scale: float = 1.0, convert_yz: bool = False) → ansys.rocky.app.ra_process_element.RAPolyhedronProcess | None

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.

RAUserProcessCollection.GetPolyhedronProcessNames()

Get the names of created polyhedron processes.

Returns:

The list of polyhedron user process names.

RAUserProcessCollection.CreateSurfaceUserProcess(parent: ansys.rocky.app.api_element_item.ApiElementItem, stl_filename: str, name: str | None = None, import_scale: float = 1.0, convert_yz: bool = False) → ansys.rocky.app.ra_process_element.RASurfaceUserProcess | None

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.

RAUserProcessCollection.GetSurfaceUserProcessNames() → list[str]

Get the names of created surfaces processes.

Returns:

The list of surfaces user process names.

RAUserProcessCollection.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

RAUserProcessCollection.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

RAUserProcessCollection.GetParticleToContactProcessNames()

Get the names of created Particle to Contact processes.

Returns:

The list of Particle to Contact user process names

RAUserProcessCollection.GetContactToParticleProcessNames()

Get the names of created Contact to Particle processes.

Returns:

The list of Contact to Particle user process names

RAUserProcessCollection.CreateStreamlinesUserProcess(parent: ansys.rocky.app.api_element_item.ApiElementItem, name: str | None = None) → ansys.rocky.app.ra_streamlines_user_process.RAStreamlinesUserProcess | 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

RAUserProcessCollection.GetStreamlinesUserProcessNames() → list[str]

Get the names of created streamlines processes.

Returns:

The list of streamlines user process names.