RABaseCFDCoupling

class ansys.rocky.app.ra_cfd_coupling.RABaseCFDCoupling

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem

Base class for PrePost Scripting wrappers for the various CFD coupling modes.

Overview

Methods

GetCFDParametersList	Get the list of per-Particle CFD parameter sets.
SetPartIdIfValid	Subclasses should implement this method if it’s a Process with visualization
GetConvectiveHeatTransferLaw	Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual
SetConvectiveHeatTransferLaw	Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual
GetDragLaw	Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual
SetDragLaw	Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual
GetLiftLaw	Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual
SetLiftLaw	Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual
GetMorsiAndAlexanderK1	Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual
SetMorsiAndAlexanderK1	Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual
GetMorsiAndAlexanderK2	Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual
SetMorsiAndAlexanderK2	Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual
GetMorsiAndAlexanderK3	Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual
SetMorsiAndAlexanderK3	Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual
GetSyamlalObrienC1	Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual
SetSyamlalObrienC1	Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual
GetSyamlalObrienD1	Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual
SetSyamlalObrienD1	Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual
GetTorqueLaw	Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual
SetTorqueLaw	Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual
GetUseUserDefinedConstants	Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual
SetUseUserDefinedConstants	Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual
GetVirtualMassLaw	Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual
SetVirtualMassLaw	Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual

Import detail

from ansys.rocky.app.ra_cfd_coupling import RABaseCFDCoupling

Method detail

RABaseCFDCoupling.GetCFDParametersList() → ansys.rocky.app.ra_cfd_parameters.RACFDParametersList

Get the list of per-Particle CFD parameter sets.

Return type:

RACFDParametersList

RABaseCFDCoupling.SetPartIdIfValid() → None

Subclasses should implement this method if it’s a Process with visualization

RABaseCFDCoupling.GetConvectiveHeatTransferLaw()

Get the current “Convective Heat Transfer Law”. This is a shortcut to access the “Convective Heat Transfer Law” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Convective Heat Transfer Law”.

RABaseCFDCoupling.SetConvectiveHeatTransferLaw(value) → None

Set the current “Convective Heat Transfer Law”. This is a shortcut to set the “Convective Heat Transfer Law” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetConvectiveHeatTransferLaw()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetDragLaw()

Get the current “Drag Law”. This is a shortcut to access the “Drag Law” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetDragLaw()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Drag Law”.

RABaseCFDCoupling.SetDragLaw(value) → None

Set the current “Drag Law”. This is a shortcut to set the “Drag Law” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetDragLaw()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetLiftLaw()

Get the current “Lift Law”. This is a shortcut to access the “Lift Law” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetLiftLaw()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Lift Law”.

RABaseCFDCoupling.SetLiftLaw(value) → None

Set the current “Lift Law”. This is a shortcut to set the “Lift Law” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetLiftLaw()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetMorsiAndAlexanderK1()

Get the current “Morsi And Alexander K1”. This is a shortcut to access the “Morsi And Alexander K1” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetMorsiAndAlexanderK1()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Morsi And Alexander K1”.

RABaseCFDCoupling.SetMorsiAndAlexanderK1(value) → None

Set the current “Morsi And Alexander K1”. This is a shortcut to set the “Morsi And Alexander K1” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetMorsiAndAlexanderK1()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetMorsiAndAlexanderK2()

Get the current “Morsi And Alexander K2”. This is a shortcut to access the “Morsi And Alexander K2” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetMorsiAndAlexanderK2()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Morsi And Alexander K2”.

RABaseCFDCoupling.SetMorsiAndAlexanderK2(value) → None

Set the current “Morsi And Alexander K2”. This is a shortcut to set the “Morsi And Alexander K2” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetMorsiAndAlexanderK2()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetMorsiAndAlexanderK3()

Get the current “Morsi And Alexander K3”. This is a shortcut to access the “Morsi And Alexander K3” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetMorsiAndAlexanderK3()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Morsi And Alexander K3”.

RABaseCFDCoupling.SetMorsiAndAlexanderK3(value) → None

Set the current “Morsi And Alexander K3”. This is a shortcut to set the “Morsi And Alexander K3” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetMorsiAndAlexanderK3()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetSyamlalObrienC1()

Get the current “Syamlal Obrien C1”. This is a shortcut to access the “Syamlal Obrien C1” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetSyamlalObrienC1()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Syamlal Obrien C1”.

RABaseCFDCoupling.SetSyamlalObrienC1(value) → None

Set the current “Syamlal Obrien C1”. This is a shortcut to set the “Syamlal Obrien C1” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetSyamlalObrienC1()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetSyamlalObrienD1()

Get the current “Syamlal Obrien D1”. This is a shortcut to access the “Syamlal Obrien D1” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetSyamlalObrienD1()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Syamlal Obrien D1”.

RABaseCFDCoupling.SetSyamlalObrienD1(value) → None

Set the current “Syamlal Obrien D1”. This is a shortcut to set the “Syamlal Obrien D1” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetSyamlalObrienD1()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetTorqueLaw()

Get the current “Torque Law”. This is a shortcut to access the “Torque Law” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetTorqueLaw()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Torque Law”.

RABaseCFDCoupling.SetTorqueLaw(value) → None

Set the current “Torque Law”. This is a shortcut to set the “Torque Law” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetTorqueLaw()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetUseUserDefinedConstants()

Get the current “Use User Defined Constants”. This is a shortcut to access the “Use User Defined Constants” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetUseUserDefinedConstants()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Use User Defined Constants”.

RABaseCFDCoupling.SetUseUserDefinedConstants(value) → None

Set the current “Use User Defined Constants”. This is a shortcut to set the “Use User Defined Constants” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetUseUserDefinedConstants()

Raises:

RockyApiError – If there are no Particles in the project yet.

RABaseCFDCoupling.GetVirtualMassLaw()

Get the current “Virtual Mass Law”. This is a shortcut to access the “Virtual Mass Law” of the individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.GetVirtualMassLaw()

Raises:

RockyApiError – If there are no Particles in the project yet, or if the RACFDPerParticleParameters for the Particles have different values for the “Virtual Mass Law”.

RABaseCFDCoupling.SetVirtualMassLaw(value) → None

Set the current “Virtual Mass Law”. This is a shortcut to set the “Virtual Mass Law” of all individual RACFDPerParticleParameters configured in the coupling.

See also RACFDPerParticleParameters.SetVirtualMassLaw()

Raises:

RockyApiError – If there are no Particles in the project yet.