RACFDCoupling

class ansys.rocky.app.ra_cfd_coupling.RACFDCoupling(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper to configure the CFD coupling mode in a project.

This wrapper can be accessed directly via the project’s RAStudy:

cfd_coupling = study.GetCFDCoupling()
cfd_coupling.SetupFluentTwoWay('fluent.cas')
two_way_process = cfd_coupling.GetCouplingProcess()

Overview

Constructors

GetWrappedClass
GetClassName

Methods

SetupNoCoupling	Configure the project to use no CFD coupling.
SetupOneWayLBM	Configure the project to use 1-Way LBM.
GetOneWayLBM	Get the PrePost Scripting wrapper for 1-Way LBM properties.
SetupOneWayFluent	Configure the project to use 1-Way Fluent.
SetupTwoWayFluent	Configure the project to use 2-Way Fluent.
SetupFluentTwoWaySemiResolved	Configure the project to use Fluent Two-Way Semi Resolved.
SetupOneWayConstant	Configure the project to use 1-Way Constant.
GetCouplingMode	rtype: unicode
GetCouplingProcess	return:
SetCurrentCouplingPartId

Import detail

from ansys.rocky.app.ra_cfd_coupling import RACFDCoupling

Method detail

classmethod RACFDCoupling.GetWrappedClass() → type

classmethod RACFDCoupling.GetClassName() → str

RACFDCoupling.SetupNoCoupling()

Configure the project to use no CFD coupling.

RACFDCoupling.SetupOneWayLBM() → ansys.rocky.app.ra_airflow.RAAirFlow | None

Configure the project to use 1-Way LBM.

RACFDCoupling.GetOneWayLBM() → ansys.rocky.app.ra_airflow.RAAirFlow | None

Get the PrePost Scripting wrapper for 1-Way LBM properties.

Returns None if the current CFD coupling mode isn’t Air Flow.

Return type:

RAAirFlow

RACFDCoupling.SetupOneWayFluent(f2r_filename: str) → RACFDCouplingTypes | None

Configure the project to use 1-Way Fluent.

Parameters:

f2r_filename – str The exported file name describing the Fluent simulation

RACFDCoupling.SetupTwoWayFluent(cas_filename: str) → RACFDCouplingTypes | None

Configure the project to use 2-Way Fluent.

Parameters:

cas_filename – str The Fluent file name describing the Fluent simulation

RACFDCoupling.SetupFluentTwoWaySemiResolved(cas_filename: str) → RACFDCouplingTypes | None

Configure the project to use Fluent Two-Way Semi Resolved.

Parameters:

cas_filename – The filename describing the Fluent simulation

RACFDCoupling.SetupOneWayConstant() → RACFDCouplingTypes | None

Configure the project to use 1-Way Constant.

RACFDCoupling.GetCouplingMode() → str

Return type:

unicode

Returns:

The current coupling mode

RACFDCoupling.GetCouplingProcess() → RACFDCouplingTypes | None

Returns:

The configured coupling process

RACFDCoupling.SetCurrentCouplingPartId() → None