RACFDParametersList

class ansys.rocky.app.ra_cfd_parameters.RACFDParametersList

Bases: ansys.rocky.app.ra_list.RAList[RACFDPerParticleParameters]

Rocky PrePost Scripting wrapper to manipulate the list of per-particle CFD parameters in a CFD coupling configuration.

To get the RACFDParametersList from a CFD coupling wrapper (such as RAConstantOneWayCoupling, RAFluentOneWaySteadyCoupling, or RAFluentTwoWayCoupling), use:

parameters_list = coupling_process.GetCFDParametersList()

The RACFDParametersList class acts as a regular Python list, with the usual methods to iterate and access individual parameter sets. Note that it’s not possible to add and remove items from the list, as they are added and removed automatically as Particles are added or removed from the project.

The items in the parameters list are of type RACFDPerParticleParameters.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetParametersFor	Get the set of CFD parameters for a given Particle.
New	Overriden: Raises an error when called.
Remove	Overriden: Raises an error when called.
Clear	Overriden: Raises an error when called.

Special methods

__delitem__

Overriden: Raises an error when called.

Import detail

from ansys.rocky.app.ra_cfd_parameters import RACFDParametersList

Method detail

classmethod RACFDParametersList.GetWrappedClass()

classmethod RACFDParametersList.GetClassName()

RACFDParametersList.GetParametersFor(particle)

Get the set of CFD parameters for a given Particle.

Parameters:

particle (RAParticle or str) – Either the PrePost Scripting wrapper for a Particle, or the name of the Particle.

Return type:

RACFDPerParticleParameters

RACFDParametersList.New() → None

Overriden: Raises an error when called.

RACFDPerParticleParameters are created and removed automatically when Particles are added or removed.

RACFDParametersList.Remove(item) → None

Overriden: Raises an error when called.

RACFDPerParticleParameters are created and removed automatically when Particles are added or removed.

RACFDParametersList.Clear() → None

Overriden: Raises an error when called.

RACFDPerParticleParameters are created and removed automatically when Particles are added or removed.

RACFDParametersList.__delitem__(index) → None

Overriden: Raises an error when called.

RACFDPerParticleParameters are created and removed automatically when Particles are added or removed.