`RAInletsOutletsCollection`#

class ansys.rocky.app.ra_inlets_outlets_collection.RAInletsOutletsCollection#

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

This wrapper corresponds to the “Inputs” item in the project’s data tree. To retrieve the RAInletsOutletsCollection from a RAStudy, use:

input_collection = study.GetInletsOutletsCollection()

Instances of the RAInletsOutletsCollection class act as regular Python lists, and can be iterated on, accessed via index, etc:

input_1 = input_collection.New()
input_2 = input_collection[1]
del input_collection[0]
for input in input_collection:
    print(input.GetName())

Items in this list are of type RAParticleInlet.

Overview#

Constructors

`GetWrappedClass`
`GetClassName`

Methods

`New`	Add a new item. Returns the newly created item.
`AddParticleInlet`	Add a new ParticleInlet. Returns the newly created item.
`AddOutlet`	Add a new Outlet. Returns the newly created item.
`AddVolumetricInlet`	Add a new VolumeFill. Returns the newly created item.
`AddCustomInput`	Add a new CustomInput. Returns the newly created item.
`AddFluidInlet`	Add a new SPHInlet. Returns the newly created item.
`GetParticleInputNames`	Get the names of all particle inputs.
`GetParticleInput`	Get the particle input with the given name.

from ansys.rocky.app.ra_inlets_outlets_collection import RAInletsOutletsCollection

RAInletsOutletsCollection.New()#

Add a new item. Returns the newly created item.

RAInletsOutletsCollection.AddParticleInlet() → ansys.rocky.app.ra_particle_inlet.RAParticleInlet#: Add a new ParticleInlet. Returns the newly created item.

RAInletsOutletsCollection.AddOutlet() → ansys.rocky.app.ra_outlet.RAOutlet#: Add a new Outlet. Returns the newly created item.

RAInletsOutletsCollection.AddVolumetricInlet() → ansys.rocky.app.ra_volumetric_inlet.RAVolumetricInlet#: Add a new VolumeFill. Returns the newly created item.

RAInletsOutletsCollection.AddCustomInput() → ansys.rocky.app.ra_custom_input.RACustomInput#: Add a new CustomInput. Returns the newly created item.

RAInletsOutletsCollection.AddFluidInlet() → ansys.rocky.app.ra_fluid_inlet.RAFluidInlet#: Add a new SPHInlet. Returns the newly created item.

RAInletsOutletsCollection.GetParticleInputNames()#

Get the names of all particle inputs.

RAInletsOutletsCollection.GetParticleInput(input_name)#

Get the particle input with the given name.