Skip to content

Ansys Rocky PrePost Scripting Manual 2026 R1 #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AnsMelanie merged 1 commit into from
Feb 23, 2026
Merged

Ansys Rocky PrePost Scripting Manual 2026 R1 #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
410 changes: 410 additions & 0 deletions 2026R1/rocky-prepost-scripting-manual-26-r1/RA3DWindow.md
View file
Open in desktop

Large diffs are not rendered by default.

234 changes: 123 additions & 111 deletions 2026R1/rocky-prepost-scripting-manual-26-r1/RAAirFlow.md
View file
Open in desktop

Large diffs are not rendered by default.

69 changes: 10 additions & 59 deletions 2026R1/rocky-prepost-scripting-manual-26-r1/RACFDCoupling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,16 @@ two_way_process = cfd_coupling.GetCouplingProcess()
**Methods:**

| Name | Description |
|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [`GetAirFlow`](#generated.RACFDCoupling.GetAirFlow)() | Deprecated: Use GetOneWayLBM instead. |
| [`GetCouplingMode`](#generated.RACFDCoupling.GetCouplingMode)() | |
| [`GetCouplingProcess`](#generated.RACFDCoupling.GetCouplingProcess)() | |
| [`GetOneWayLBM`](#generated.RACFDCoupling.GetOneWayLBM)() | Get the PrePost Scripting wrapper for 1-Way LBM properties. |
| [`SetupAirFlow`](#generated.RACFDCoupling.SetupAirFlow)() | Deprecated: Use SetupOneWayLBM instead. |
| [`SetupCFDConstantOneWayCouplingProcess`](#generated.RACFDCoupling.SetupCFDConstantOneWayCouplingProcess)() | Deprecated: Use SetupOneWayConstant instead. |
| [`SetupConstantOneWay`](#generated.RACFDCoupling.SetupConstantOneWay)() | Deprecated: Use SetupOneWayConstant instead. |
| [`SetupFluentOneWaySteadyState`](#generated.RACFDCoupling.SetupFluentOneWaySteadyState)(f2r_filename) | Deprecated: Use SetupOneWayFluent instead. |
| [`SetupFluentTwoWay`](#generated.RACFDCoupling.SetupFluentTwoWay)(cas_filename) | Deprecated: Use SetupTwoWayFluent instead. |
| [`SetupFluentTwoWaySemiResolved`](#generated.RACFDCoupling.SetupFluentTwoWaySemiResolved)(cas_filename) | Configure the project to use Fluent Two-Way Semi Resolved. |
| [`SetupNoCoupling`](#generated.RACFDCoupling.SetupNoCoupling)() | Configure the project to use no CFD coupling. |
| [`SetupOneWayConstant`](#generated.RACFDCoupling.SetupOneWayConstant)() | Configure the project to use 1-Way Constant. |
| [`SetupOneWayFluent`](#generated.RACFDCoupling.SetupOneWayFluent)(f2r_filename) | Configure the project to use 1-Way Fluent. |
| [`SetupOneWayFluentSteadyState`](#generated.RACFDCoupling.SetupOneWayFluentSteadyState)(f2r_filename) | Deprecated: Use SetupOneWayFluent instead. |
| [`SetupOneWayLBM`](#generated.RACFDCoupling.SetupOneWayLBM)() | Configure the project to use 1-Way LBM. |
| [`SetupTwoWayFluent`](#generated.RACFDCoupling.SetupTwoWayFluent)(cas_filename) | Configure the project to use 2-Way Fluent. |

<a id="generated.RACFDCoupling.GetAirFlow"></a>

#### GetAirFlow()

Deprecated: Use GetOneWayLBM instead.
|---------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [`GetCouplingMode`](#generated.RACFDCoupling.GetCouplingMode)() | |
| [`GetCouplingProcess`](#generated.RACFDCoupling.GetCouplingProcess)() | |
| [`GetOneWayLBM`](#generated.RACFDCoupling.GetOneWayLBM)() | Get the PrePost Scripting wrapper for 1-Way LBM properties. |
| [`SetupFluentTwoWaySemiResolved`](#generated.RACFDCoupling.SetupFluentTwoWaySemiResolved)(cas_filename) | Configure the project to use Fluent Two-Way Semi Resolved. |
| [`SetupNoCoupling`](#generated.RACFDCoupling.SetupNoCoupling)() | Configure the project to use no CFD coupling. |
| [`SetupOneWayConstant`](#generated.RACFDCoupling.SetupOneWayConstant)() | Configure the project to use 1-Way Constant. |
| [`SetupOneWayFluent`](#generated.RACFDCoupling.SetupOneWayFluent)(f2r_filename) | Configure the project to use 1-Way Fluent. |
| [`SetupOneWayLBM`](#generated.RACFDCoupling.SetupOneWayLBM)() | Configure the project to use 1-Way LBM. |
| [`SetupTwoWayFluent`](#generated.RACFDCoupling.SetupTwoWayFluent)(cas_filename) | Configure the project to use 2-Way Fluent. |

<a id="generated.RACFDCoupling.GetCouplingMode"></a>

Expand Down Expand Up @@ -75,36 +62,6 @@ Returns None if the current CFD coupling mode isn’t Air Flow.
* **Return type:**
[RAAirFlow](RAAirFlow.md#generated.RAAirFlow)

<a id="generated.RACFDCoupling.SetupAirFlow"></a>

#### SetupAirFlow()

Deprecated: Use SetupOneWayLBM instead.

<a id="generated.RACFDCoupling.SetupCFDConstantOneWayCouplingProcess"></a>

#### SetupCFDConstantOneWayCouplingProcess()

Deprecated: Use SetupOneWayConstant instead.

<a id="generated.RACFDCoupling.SetupConstantOneWay"></a>

#### SetupConstantOneWay()

Deprecated: Use SetupOneWayConstant instead.

<a id="generated.RACFDCoupling.SetupFluentOneWaySteadyState"></a>

#### SetupFluentOneWaySteadyState(f2r_filename: str)

Deprecated: Use SetupOneWayFluent instead.

<a id="generated.RACFDCoupling.SetupFluentTwoWay"></a>

#### SetupFluentTwoWay(cas_filename: str)

Deprecated: Use SetupTwoWayFluent instead.

<a id="generated.RACFDCoupling.SetupFluentTwoWaySemiResolved"></a>

#### SetupFluentTwoWaySemiResolved(cas_filename: str)
Expand Down Expand Up @@ -136,12 +93,6 @@ Configure the project to use 1-Way Fluent.
**f2r_filename** – str
The exported file name describing the Fluent simulation

<a id="generated.RACFDCoupling.SetupOneWayFluentSteadyState"></a>

#### SetupOneWayFluentSteadyState(f2r_filename: str)

Deprecated: Use SetupOneWayFluent instead.

<a id="generated.RACFDCoupling.SetupOneWayLBM"></a>

#### SetupOneWayLBM()
Expand Down
7 changes: 0 additions & 7 deletions 2026R1/rocky-prepost-scripting-manual-26-r1/RACalculations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Rocky api for particles calculations
| [`CreateDivisionsTagging`](#generated.RACalculations.CreateDivisionsTagging)(selection) | Create a Divisions Tagging calculator for the given particle-based selection process. |
| [`CreateSelectionFlipCount`](#generated.RACalculations.CreateSelectionFlipCount)(selection) | Create a flip count grid function for the given selection process |
| [`CreateSelectionResidenceTime`](#generated.RACalculations.CreateSelectionResidenceTime)(selection) | Create a residence time grid function for the given selection process |
| [`CreateSelectionTagging`](#generated.RACalculations.CreateSelectionTagging)(selection) | Deprecated: Use [`CreateTagging()`](#generated.RACalculations.CreateTagging) instead. |
| [`CreateTagging`](#generated.RACalculations.CreateTagging)(selection) | Create a Tagging calculator for the given particle-based selection process. |
| [`GetDivisionsTagging`](#generated.RACalculations.GetDivisionsTagging)(name) | Get the Divisions Tagging calculator with the given name. |
| [`GetDivisionsTaggingNames`](#generated.RACalculations.GetDivisionsTaggingNames)() | Get a list of the names of all Divisions Taggings in Particles Calculations. |
Expand Down Expand Up @@ -48,12 +47,6 @@ Create a flip count grid function for the given selection process

Create a residence time grid function for the given selection process

<a id="generated.RACalculations.CreateSelectionTagging"></a>

#### CreateSelectionTagging(selection: RAGridProcessElementItem)

Deprecated: Use [`CreateTagging()`](#generated.RACalculations.CreateTagging) instead.

<a id="generated.RACalculations.CreateTagging"></a>

#### CreateTagging(selection: RAGridProcessElementItem)
Expand Down
Loading