Rocky PrePost scripting 2026 R1

RACFDPerParticleParameters

Last update: 23.02.2026

class RACFDPerParticleParameters

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>')

Methods:

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

GetConvectiveHeatTransferLaw()

Get “Convective Heat Transfer Law” as a string.

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

GetDragLaw()

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’].

GetLiftLaw()

Get “Lift Law” as a string.

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

GetMorsiAndAlexanderK1()

Get the value of “Morsi And Alexander K1”.

GetMorsiAndAlexanderK2()

Get the value of “Morsi And Alexander K2”.

GetMorsiAndAlexanderK3()

Get the value of “Morsi And Alexander K3”.

GetSyamlalObrienC1()

Get the value of “Syamlal Obrien C1”.

GetSyamlalObrienD1()

Get the value of “Syamlal Obrien D1”.

GetTorqueLaw()

Get “Torque Law” as a string.

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

GetUseUserDefinedConstants()

Get the value of “Use User Defined Constants”.

GetValidConvectiveHeatTransferLawValues()

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

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

GetValidDragLawValues()

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’].

GetValidLiftLawValues()

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

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

GetValidTorqueLawValues()

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

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

GetValidVirtualMassLawValues()

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

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

GetVirtualMassLaw()

Get “Virtual Mass Law” as a string.

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

SetConvectiveHeatTransferLaw(value: str)

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.

SetDragLaw(value: str)

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.

SetLiftLaw(value: str)

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.

SetMorsiAndAlexanderK1(value: str | float)

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.

SetMorsiAndAlexanderK2(value: str | float)

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.

SetMorsiAndAlexanderK3(value: str | float)

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.

SetSyamlalObrienC1(value: str | float)

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.

SetSyamlalObrienD1(value: str | float)

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.

SetTorqueLaw(value: str)

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.

SetUseUserDefinedConstants(value: bool)

Set the value of “Use User Defined Constants”.

  • Parameters: value – The value to set.

SetVirtualMassLaw(value: str)

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.

Connect with Ansys