RACFDPerParticleParameters

class ansys.rocky.app.ra_cfd_parameters.RACFDPerParticleParameters(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper representing the set of CFD parameters for a specific Particle.

Access individual sets of parameters via a RABaseCFDCoupling’s parameters list:

parameters_list = coupling_process.GetCFDParametersList()
parameters = parameters_list.GetParametersFor('Particle <01>')

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetConvectiveHeatTransferLaw	Get “Convective Heat Transfer Law” as a string.
SetConvectiveHeatTransferLaw	Set the value of “Convective Heat Transfer Law”.
GetValidConvectiveHeatTransferLawValues	Get a list of all possible values for “Convective Heat Transfer Law”.
GetDragLaw	Get “Drag Law” as a string.
SetDragLaw	Set the value of “Drag Law”.
GetValidDragLawValues	Get a list of all possible values for “Drag Law”.
GetLiftLaw	Get “Lift Law” as a string.
SetLiftLaw	Set the value of “Lift Law”.
GetValidLiftLawValues	Get a list of all possible values for “Lift Law”.
GetMorsiAndAlexanderK1	Get the value of “Morsi And Alexander K1”.
SetMorsiAndAlexanderK1	Set the value of “Morsi And Alexander K1”.
GetMorsiAndAlexanderK2	Get the value of “Morsi And Alexander K2”.
SetMorsiAndAlexanderK2	Set the value of “Morsi And Alexander K2”.
GetMorsiAndAlexanderK3	Get the value of “Morsi And Alexander K3”.
SetMorsiAndAlexanderK3	Set the value of “Morsi And Alexander K3”.
GetSyamlalObrienC1	Get the value of “Syamlal Obrien C1”.
SetSyamlalObrienC1	Set the value of “Syamlal Obrien C1”.
GetSyamlalObrienD1	Get the value of “Syamlal Obrien D1”.
SetSyamlalObrienD1	Set the value of “Syamlal Obrien D1”.
GetTorqueLaw	Get “Torque Law” as a string.
SetTorqueLaw	Set the value of “Torque Law”.
GetValidTorqueLawValues	Get a list of all possible values for “Torque Law”.
GetUseUserDefinedConstants	Get the value of “Use User Defined Constants”.
SetUseUserDefinedConstants	Set the value of “Use User Defined Constants”.
GetVirtualMassLaw	Get “Virtual Mass Law” as a string.
SetVirtualMassLaw	Set the value of “Virtual Mass Law”.
GetValidVirtualMassLawValues	Get a list of all possible values for “Virtual Mass Law”.

Import detail

from ansys.rocky.app.ra_cfd_parameters import RACFDPerParticleParameters

Method detail

classmethod RACFDPerParticleParameters.GetWrappedClass()

classmethod RACFDPerParticleParameters.GetClassName()

RACFDPerParticleParameters.GetConvectiveHeatTransferLaw() → str

Get “Convective Heat Transfer Law” as a string.

Returns:

The returned value will be one of [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’].

RACFDPerParticleParameters.SetConvectiveHeatTransferLaw(value: str) → None

Set the value of “Convective Heat Transfer Law”.

Parameters:

value – The value to set. Must be one of [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’].

Raises:

RockyApiError – If value is not a valid “Convective Heat Transfer Law” option.

RACFDPerParticleParameters.GetValidConvectiveHeatTransferLawValues() → list[str]

Get a list of all possible values for “Convective Heat Transfer Law”.

Returns:

The returned list is [‘none’, ‘RanzMarshall1952’, ‘Whitaker1972’, ‘Gunn1978’, ‘custom’].

RACFDPerParticleParameters.GetDragLaw() → str

Get “Drag Law” as a string.

Returns:

The returned value will be one of [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’].

RACFDPerParticleParameters.SetDragLaw(value: str) → None

Set the value of “Drag Law”.

Parameters:

value – The value to set. Must be one of [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’].

Raises:

RockyApiError – If value is not a valid “Drag Law” option.

RACFDPerParticleParameters.GetValidDragLawValues() → list[str]

Get a list of all possible values for “Drag Law”.

Returns:

The returned list is [‘WenYu1966’, ‘SchillerNaumann1933’, ‘HaiderLevenspiel1989’, ‘Ganser1993’, ‘Ergun1958’, ‘GidaspowBezburuahDing1992’, ‘HuilinGidaspow2003’, ‘DiFelice1994’, ‘Dallavalle1948’, ‘MarheinekeWegener2011’, ‘SyamlalOBrien1987’, ‘MorsiAlexander1972’, ‘HillKochLadd2001’, ‘HillKoch2001’, ‘custom’].

RACFDPerParticleParameters.GetLiftLaw() → str

Get “Lift Law” as a string.

Returns:

The returned value will be one of [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’].

RACFDPerParticleParameters.SetLiftLaw(value: str) → None

Set the value of “Lift Law”.

Parameters:

value – The value to set. Must be one of [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’].

Raises:

RockyApiError – If value is not a valid “Lift Law” option.

RACFDPerParticleParameters.GetValidLiftLawValues() → list[str]

Get a list of all possible values for “Lift Law”.

Returns:

The returned list is [‘none’, ‘Saffman1968’, ‘Mei1992’, ‘custom’].

RACFDPerParticleParameters.GetMorsiAndAlexanderK1() → float

Get the value of “Morsi And Alexander K1”.

RACFDPerParticleParameters.SetMorsiAndAlexanderK1(value: str | float) → None

Set the value of “Morsi And Alexander K1”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RACFDPerParticleParameters.GetMorsiAndAlexanderK2() → float

Get the value of “Morsi And Alexander K2”.

RACFDPerParticleParameters.SetMorsiAndAlexanderK2(value: str | float) → None

Set the value of “Morsi And Alexander K2”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RACFDPerParticleParameters.GetMorsiAndAlexanderK3() → float

Get the value of “Morsi And Alexander K3”.

RACFDPerParticleParameters.SetMorsiAndAlexanderK3(value: str | float) → None

Set the value of “Morsi And Alexander K3”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RACFDPerParticleParameters.GetSyamlalObrienC1() → float

Get the value of “Syamlal Obrien C1”.

RACFDPerParticleParameters.SetSyamlalObrienC1(value: str | float) → None

Set the value of “Syamlal Obrien C1”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RACFDPerParticleParameters.GetSyamlalObrienD1() → float

Get the value of “Syamlal Obrien D1”.

RACFDPerParticleParameters.SetSyamlalObrienD1(value: str | float) → None

Set the value of “Syamlal Obrien D1”.

Parameters:

value – The value to set. This value can be an expression with input variables or float type.

RACFDPerParticleParameters.GetTorqueLaw() → str

Get “Torque Law” as a string.

Returns:

The returned value will be one of [‘none’, ‘DennisSinghIngham1980’, ‘custom’].

RACFDPerParticleParameters.SetTorqueLaw(value: str) → None

Set the value of “Torque Law”.

Parameters:

value – The value to set. Must be one of [‘none’, ‘DennisSinghIngham1980’, ‘custom’].

Raises:

RockyApiError – If value is not a valid “Torque Law” option.

RACFDPerParticleParameters.GetValidTorqueLawValues() → list[str]

Get a list of all possible values for “Torque Law”.

Returns:

The returned list is [‘none’, ‘DennisSinghIngham1980’, ‘custom’].

RACFDPerParticleParameters.GetUseUserDefinedConstants() → bool

Get the value of “Use User Defined Constants”.

RACFDPerParticleParameters.SetUseUserDefinedConstants(value: bool) → None

Set the value of “Use User Defined Constants”.

Parameters:

value – The value to set.

RACFDPerParticleParameters.GetVirtualMassLaw() → str

Get “Virtual Mass Law” as a string.

Returns:

The returned value will be one of [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’].

RACFDPerParticleParameters.SetVirtualMassLaw(value: str) → None

Set the value of “Virtual Mass Law”.

Parameters:

value – The value to set. Must be one of [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’].

Raises:

RockyApiError – If value is not a valid “Virtual Mass Law” option.

RACFDPerParticleParameters.GetValidVirtualMassLawValues() → list[str]

Get a list of all possible values for “Virtual Mass Law”.

Returns:

The returned list is [‘none’, ‘constant’, ‘Paladino2005’, ‘IshiiMishima1984’, ‘custom’].