RAFluentSemiResolvedCoupling

class RAFluentSemiResolvedCoupling

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

Methods:

Name	Description
GetCouplingFilesKept()	Get the value of "Coupling Files Kept".
GetFluentAdditionalArgs()	Get the value of "Fluent Additional Args".
GetFluentExecutionMode()	Get "Fluent Execution Mode" as a string.
GetFluentOutputFrequencyMultiplier()	Get the value of "Fluent Output Frequency Multiplier".
GetFluentReleases()	Get a list of available Fluent releases.
GetFluentSolverProcesses()	Get the value of "Fluent Solver Processes".
GetFluentVersion()	Get the value of "Version".
GetUseDatInitialization()	Get the value of "Use Dat Initialization".
GetValidFluentExecutionModeValues()	Get a list of all possible values for "Fluent Execution Mode".
SetCouplingFilesKept(value)	Set the value of "Coupling Files Kept".
SetFluentAdditionalArgs(value)	Set the value of "Fluent Additional Args".
SetFluentExecutionMode(value)	Set the value of "Fluent Execution Mode".
SetFluentOutputFrequencyMultiplier(value)	Set the value of "Fluent Output Frequency Multiplier".
SetFluentSolverProcesses(value)	Set the value of "Fluent Solver Processes".
SetFluentVersion(fluent_version)	Set the value of "Version".
SetPartIdIfValid()	Set the process' part id (unused for now)
SetUseDatInitialization(value)	Set the value of "Use Dat Initialization".
SetupStoreFiles(cas_filename[, case_config])	Copies CAS file to Rocky's project folder and update Fluent info

GetCouplingFilesKept()

Get the value of “Coupling Files Kept”.

GetFluentAdditionalArgs()

Get the value of “Fluent Additional Args”.

GetFluentExecutionMode()

Get “Fluent Execution Mode” as a string.

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

GetFluentOutputFrequencyMultiplier()

Get the value of “Fluent Output Frequency Multiplier”.

GetFluentReleases()

Get a list of available Fluent releases.

• Return type: list(unicode)
• Returns: The list of available Fluent releases

GetFluentSolverProcesses()

Get the value of “Fluent Solver Processes”.

GetFluentVersion()

Get the value of “Version”.

• Return type: str

GetUseDatInitialization()

Get the value of “Use Dat Initialization”.

GetValidFluentExecutionModeValues()

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

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

SetCouplingFilesKept(value: Union[str, int])

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.

SetFluentAdditionalArgs(value: str)

Set the value of “Fluent Additional Args”.

• Parameters: value – The value to set.

SetFluentExecutionMode(value: str)

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.

SetFluentOutputFrequencyMultiplier(value: Union[str, int])

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.

SetFluentSolverProcesses(value: Union[str, int])

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.

SetFluentVersion(fluent_version: str)

Set the value of “Version”.

• Parameters: fluent_version (str) – The caption of the Fluent Version that can be seen in the UI.

SetPartIdIfValid()

Set the process’ part id (unused for now)

SetUseDatInitialization(value: bool)

Set the value of “Use Dat Initialization”.

• Parameters: value – The value to set.

SetupStoreFiles(cas_filename: str, case_config: Optional[FluentCaseConfig] = None)

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