`RAGeometryCollection`#

class ansys.rocky.app.ra_geometry_collection.RAGeometryCollection#

Bases: ansys.rocky.app.ra_list.RAList

Rocky PrePost Scripting wrapper for the collection of geometries in a project.

The class represents the “Geometries” item on the project data tree. To get the RAGeometryCollection from a RAStudy, use:

geometry_collection = study.GetGeometryCollection()

This class contains methods to iterate and retrieve the geometries in a given project, manipulating the collection as a regular Python list, e.g.:

for geometry in geometry_collection:
    print(geometry.GetName())

feed_conveyor = geometry_collection[1]
inlet = geometry_collection.GetGeometry('Inlet <01>')

To create the different kind of geometries (conveyors, inlets and custom geometries), see RAStudy.

Overview#

Constructors

`GetWrappedClass`
`GetClassName`

Methods

`GetGeometryNames`	Get the names of the geometries in this collection.
`GetGeometry`	Get a geometry from its name.
`IterInletGeometries`	Iterate over the inlet geometries.
`IterSurfaces`	Iterate over the surface geometries.
`IterWalls`	Iterate over the walls geometries.
`IterSystemCouplingWalls`	Iterate over the System Coupling walls geometries.
`GetBoundingBox`	Get the bounding box containing all geometries in this collection, at the given time.
`RemoveGeometry`	Remove the given geometry from the project.

Import detail#

from ansys.rocky.app.ra_geometry_collection import RAGeometryCollection

Method detail#

classmethod RAGeometryCollection.GetWrappedClass() → type[rocky30.models.geometry.geometry_collection.GeometryCollection]#

classmethod RAGeometryCollection.GetClassName() → str#

RAGeometryCollection.GetGeometryNames() → list[str]#: Get the names of the geometries in this collection.

RAGeometryCollection.GetGeometry(geometry_name)#

Get a geometry from its name.

Parameters:: geometry_name (unicode)

RAGeometryCollection.IterInletGeometries() → collections.abc.Iterator[ansys.rocky.app.ra_base_geometry.RABaseGeometry]#: Iterate over the inlet geometries.

RAGeometryCollection.IterSurfaces() → collections.abc.Iterator[ansys.rocky.app.ra_base_geometry.RABaseGeometry]#: Iterate over the surface geometries.

RAGeometryCollection.IterWalls() → collections.abc.Iterator[ansys.rocky.app.ra_base_geometry.RABaseGeometry]#: Iterate over the walls geometries.

RAGeometryCollection.IterSystemCouplingWalls() → collections.abc.Iterator[ansys.rocky.app.ra_base_geometry.RABaseGeometry]#: Iterate over the System Coupling walls geometries.

RAGeometryCollection.GetBoundingBox(time_step: coilib50.time.time_step_interface.ITimeStep | None, force_load: bool = False, force_orthogonal: bool = True) → tuple[barril.units.FixedArray, barril.units.FixedArray]#

Get the bounding box containing all geometries in this collection, at the given time.

Parameters:

time_step – The time step for which the bounding box should be computed.
force_load – If True, the bounding box will be computed by loading the geometries from the project. If False, the bounding box will only be returned if it was already computed.
force_orthogonal – If True, the bounding box will be computed in an orthogonal coordinate system. If False, the bounding box will be computed in the original coordinate system of the geometries.

Returns:

The bounding box of all the geometries in the passed time step, or None if the box could not be computed.

RAGeometryCollection.RemoveGeometry(geometry: ansys.rocky.app.ra_base_geometry.RABaseGeometry | str | None) → None#: Remove the given geometry from the project.