RAFluentOneWayCoupling

class ansys.rocky.app.ra_fluent_coupling.RAFluentOneWayCoupling

Bases: ansys.rocky.app.ra_cfd_coupling.RABaseCFDCoupling

Rocky PrePost Scripting wrapper to Fluent one way CFD coupling process.

This wrapper can be accessed via the project’s RACFDCoupling:

cfd_coupling = study.GetCFDCoupling()
cfd_coupling.SetupOneWayFluent('fluent.cas')
one_way_process = cfd_coupling.GetCouplingProcess()

Overview

Constructors

GetWrappedClass
GetClassName

Methods

SetupStoreFiles	Set the file with Fluent to Rocky information.
GetAvailableCoupledBoundaryNames	Obtain the names of the boundaries available for coupling in the fluent file.
CreateCoupledBoundaries	Create a coupled boundary for each of the coupled boundary name passed by the user.
GetIsOneWayPeriodic	Get the value of “Is One Way Periodic”.
SetIsOneWayPeriodic	Set the value of “Is One Way Periodic”.
GetOverwriteCfdUpdateDistance	Get the value of “Overwrite Cfd Update Distance”.
SetOverwriteCfdUpdateDistance	Set the value of “Overwrite Cfd Update Distance”.
GetStartTime	Get the value of “Start Time”.
SetStartTime	Set the value of “Start Time”.
GetUseTurbulentDispersion	Get the value of “Use Turbulent Dispersion”.
SetUseTurbulentDispersion	Set the value of “Use Turbulent Dispersion”.
GetUserCfdUpdateDistance	Get the value of “User Cfd Update Distance”.
SetUserCfdUpdateDistance	Set the value of “User Cfd Update Distance”.

Import detail

from ansys.rocky.app.ra_fluent_coupling import RAFluentOneWayCoupling

Method detail

classmethod RAFluentOneWayCoupling.GetWrappedClass()

classmethod RAFluentOneWayCoupling.GetClassName()

RAFluentOneWayCoupling.SetupStoreFiles(filename) → None

Set the file with Fluent to Rocky information.

Parameters:

filename (str) – The filename for the .f2r file.

RAFluentOneWayCoupling.GetAvailableCoupledBoundaryNames() → collections.abc.Iterable[str]

Obtain the names of the boundaries available for coupling in the fluent file.

RAFluentOneWayCoupling.CreateCoupledBoundaries(coupled_boundary_names: list[str]) → None

Create a coupled boundary for each of the coupled boundary name passed by the user. Check GetAvailableCoupledBoundaryNames to obtain the list of available boundaries.

RAFluentOneWayCoupling.GetIsOneWayPeriodic() → bool

Get the value of “Is One Way Periodic”.

RAFluentOneWayCoupling.SetIsOneWayPeriodic(value: bool) → None

Set the value of “Is One Way Periodic”.

Parameters:

value – The value to set.

RAFluentOneWayCoupling.GetOverwriteCfdUpdateDistance() → bool

Get the value of “Overwrite Cfd Update Distance”.

RAFluentOneWayCoupling.SetOverwriteCfdUpdateDistance(value: bool) → None

Set the value of “Overwrite Cfd Update Distance”.

Parameters:

value – The value to set.

RAFluentOneWayCoupling.GetStartTime(unit: str | None = None) → float

Get the value of “Start Time”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RAFluentOneWayCoupling.SetStartTime(value: str | float, unit: str | None = None) → None

Set the value of “Start Time”.

Parameters:

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

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RAFluentOneWayCoupling.GetUseTurbulentDispersion() → bool

Get the value of “Use Turbulent Dispersion”.

RAFluentOneWayCoupling.SetUseTurbulentDispersion(value: bool) → None

Set the value of “Use Turbulent Dispersion”.

Parameters:

value – The value to set.

RAFluentOneWayCoupling.GetUserCfdUpdateDistance(unit: str | None = None) → float

Get the value of “User Cfd Update Distance”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAFluentOneWayCoupling.SetUserCfdUpdateDistance(value: str | float, unit: str | None = None) → None

Set the value of “User Cfd Update Distance”.

Parameters:

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

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.