RAFluentSemiResolvedCoupling

class ansys.rocky.app.ra_semi_resolved_coupling.RAFluentSemiResolvedCoupling(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

PrePost Scripting wrapper class for the Fluent Two-Way Semi Resolved coupling mode

Overview

Constructors

GetWrappedClass
GetClassName

Methods

SetPartIdIfValid	Set the process’ part id (unused for now)
SetupDatFilename
SetupStoreFiles	Copies CAS file to Rocky’s project folder and update Fluent info
GetFluentReleases	Get a list of available Fluent releases.
GetFluentVersion	Get the value of “Version”.
SetFluentVersion	Set the Ansys Fluent version to be used in CFD coupling (deprecated).
GetCouplingFilesKept	Get the value of “Coupling Files Kept”.
SetCouplingFilesKept	Set the value of “Coupling Files Kept”.
GetFluentAdditionalArgs	Get the value of “Fluent Additional Args”.
SetFluentAdditionalArgs	Set the value of “Fluent Additional Args”.
GetFluentExecutionMode	Get “Fluent Execution Mode” as a string.
SetFluentExecutionMode	Set the value of “Fluent Execution Mode”.
GetValidFluentExecutionModeValues	Get a list of all possible values for “Fluent Execution Mode”.
GetFluentOutputFrequencyMultiplier	Get the value of “Fluent Output Frequency Multiplier”.
SetFluentOutputFrequencyMultiplier	Set the value of “Fluent Output Frequency Multiplier”.
GetFluentSolverProcesses	Get the value of “Fluent Solver Processes”.
SetFluentSolverProcesses	Set the value of “Fluent Solver Processes”.
GetUseDatInitialization	Get the value of “Use Dat Initialization”.
SetUseDatInitialization	Set the value of “Use Dat Initialization”.

Import detail

from ansys.rocky.app.ra_semi_resolved_coupling import RAFluentSemiResolvedCoupling

Method detail

classmethod RAFluentSemiResolvedCoupling.GetWrappedClass() → type

classmethod RAFluentSemiResolvedCoupling.GetClassName() → str

RAFluentSemiResolvedCoupling.SetPartIdIfValid() → None

Set the process’ part id (unused for now)

RAFluentSemiResolvedCoupling.SetupDatFilename(dat_filename: str) → bool

RAFluentSemiResolvedCoupling.SetupStoreFiles(cas_filename: str, case_config: rocky30coupling.fluent.io.fluent_cas_description.FluentCaseConfig | None = None) → None

Copies CAS file to Rocky’s project folder and update Fluent info

RAFluentSemiResolvedCoupling.GetFluentReleases() → list[str]

Get a list of available Fluent releases.

Return type:

list(unicode)

Returns:

The list of available Fluent releases

RAFluentSemiResolvedCoupling.GetFluentVersion() → str

Get the value of “Version”.

Return type:

str

RAFluentSemiResolvedCoupling.SetFluentVersion(fluent_version: str) → str

Set the Ansys Fluent version to be used in CFD coupling (deprecated).

Currently, it’s not possible to change the version of Ansys Fluent used for CFD coupling. This method is being kept for backward compatibility (and also because there’s a chance of this feature to be brought back in future version).

RAFluentSemiResolvedCoupling.GetCouplingFilesKept() → int

Get the value of “Coupling Files Kept”.

RAFluentSemiResolvedCoupling.SetCouplingFilesKept(value: str | int) → None

Set the value of “Coupling Files Kept”.

Parameters:

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

RAFluentSemiResolvedCoupling.GetFluentAdditionalArgs() → str

Get the value of “Fluent Additional Args”.

RAFluentSemiResolvedCoupling.SetFluentAdditionalArgs(value: str) → None

Set the value of “Fluent Additional Args”.

Parameters:

value – The value to set.

RAFluentSemiResolvedCoupling.GetFluentExecutionMode() → str

Get “Fluent Execution Mode” as a string.

Returns:

The returned value will be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’].

RAFluentSemiResolvedCoupling.SetFluentExecutionMode(value: str) → None

Set the value of “Fluent Execution Mode”.

Parameters:

value – The value to set. Must be one of [‘serial’, ‘local_parallel’, ‘distributed_parallel’].

Raises:

RockyApiError – If value is not a valid “Fluent Execution Mode” option.

RAFluentSemiResolvedCoupling.GetValidFluentExecutionModeValues() → list[str]

Get a list of all possible values for “Fluent Execution Mode”.

Returns:

The returned list is [‘serial’, ‘local_parallel’, ‘distributed_parallel’].

RAFluentSemiResolvedCoupling.GetFluentOutputFrequencyMultiplier() → int

Get the value of “Fluent Output Frequency Multiplier”.

RAFluentSemiResolvedCoupling.SetFluentOutputFrequencyMultiplier(value: str | int) → None

Set the value of “Fluent Output Frequency Multiplier”.

Parameters:

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

RAFluentSemiResolvedCoupling.GetFluentSolverProcesses() → int

Get the value of “Fluent Solver Processes”.

RAFluentSemiResolvedCoupling.SetFluentSolverProcesses(value: str | int) → None

Set the value of “Fluent Solver Processes”.

Parameters:

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

RAFluentSemiResolvedCoupling.GetUseDatInitialization() → bool

Get the value of “Use Dat Initialization”.

RAFluentSemiResolvedCoupling.SetUseDatInitialization(value: bool) → None

Set the value of “Use Dat Initialization”.

Parameters:

value – The value to set.