diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RA3DWindow.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RA3DWindow.md new file mode 100644 index 0000000000..dcdd1c4871 --- /dev/null +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RA3DWindow.md @@ -0,0 +1,410 @@ + + +# RA3DWindow + + + + + + +### *class* RA3DWindow + +3D window API. + +**Methods:** + +| Name | Description | +|-----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`ApplyGridFunctionToAll`](#generated.RA3DWindow.ApplyGridFunctionToAll)(grid_function_name) | Change the coloring of all entities in this window to the specified grid function. :param grid_function_name: The name of the grid function to be shown. It is possible to pass None to set back to solid color. | +| [`CloseWindow`](#generated.RA3DWindow.CloseWindow)() | Removes this window from the application. | +| [`CreateAnimationKeyFrame`](#generated.RA3DWindow.CreateAnimationKeyFrame)([number_of_frames]) | Creates an animation key frame based on the current camera in the 3d window. | +| [`ExportAnimation`](#generated.RA3DWindow.ExportAnimation)(filename[, mode]) | | +| [`GetActiveSimulation`](#generated.RA3DWindow.GetActiveSimulation)() | | +| [`GetAnimationKeyFramesCount`](#generated.RA3DWindow.GetAnimationKeyFramesCount)() | | +| [`GetCamera`](#generated.RA3DWindow.GetCamera)() | Get the API wrapper for the 3D window's camera. | +| [`GetSize`](#generated.RA3DWindow.GetSize)() | | +| [`Hide`](#generated.RA3DWindow.Hide)(name[, model_name]) | Alias for SetVisible(False, name, model_name) . | +| [`HideEdges`](#generated.RA3DWindow.HideEdges)([name, model_name]) | Alias for SetEdgesVisible(False, name, model_name) . | +| [`HideNodes`](#generated.RA3DWindow.HideNodes)([name, model_name]) | Alias for SetNodesVisible(False, name, model_name) . | +| [`RemoveAllAnimationKeyFrames`](#generated.RA3DWindow.RemoveAllAnimationKeyFrames)() | Removes all the currently created animation key frames in the current 3d window. | +| [`Resize`](#generated.RA3DWindow.Resize)(width, height) | Resize the 3D window to the given width and height. | +| [`SetActiveSimulation`](#generated.RA3DWindow.SetActiveSimulation)(simulation_name) | Changes the simulation being shown in the current 3D window | +| [`SetAnimationCameraInterpolation`](#generated.RA3DWindow.SetAnimationCameraInterpolation)(interpolation) | | +| [`SetAnimationFPS`](#generated.RA3DWindow.SetAnimationFPS)(fps) | Sets the FPS (frames per second) to be used for the animation. | +| [`SetBackgroundColor`](#generated.RA3DWindow.SetBackgroundColor)(color) | | +| [`SetCameraPreset`](#generated.RA3DWindow.SetCameraPreset)([preset]) | Set the camera to one of the existing presets. | +| [`SetEdgesVisible`](#generated.RA3DWindow.SetEdgesVisible)(visible[, name, model_name]) | Makes the edges visible or invisible in this window (changes either the global settings for this window or the the passed grid, if the grid is not using the global settings). | +| [`SetForegroundColor`](#generated.RA3DWindow.SetForegroundColor)(color) | | +| [`SetNodesVisible`](#generated.RA3DWindow.SetNodesVisible)(visible[, name, model_name]) | Makes the nodes visible or invisible in this window (changes either the global settings for this window or the the passed grid, if the grid is not using the global settings). | +| [`SetSelectedWindow`](#generated.RA3DWindow.SetSelectedWindow)([window_name]) | Sets the given window as the currently selected window. | +| [`SetTransparency`](#generated.RA3DWindow.SetTransparency)(transparency[, name, ...]) | Sets the transparency for the given grid. | +| [`SetVisible`](#generated.RA3DWindow.SetVisible)(visible, name[, model_name]) | Makes a given element visible or invisible within this window. | +| [`Show`](#generated.RA3DWindow.Show)(name[, model_name]) | Alias for SetVisible(True, name, model_name) . | +| [`ShowEdges`](#generated.RA3DWindow.ShowEdges)([name, model_name]) | Alias for SetEdgesVisible(True, name, model_name) . | +| [`ShowGeometryGridFunction`](#generated.RA3DWindow.ShowGeometryGridFunction)(grid_function_name) | Change the coloring of all geometries in this window to the specified grid function. :param grid_function_name: The name of the grid function to be shown. It is possible to pass None to set back to solid color. | +| [`ShowGridFunction`](#generated.RA3DWindow.ShowGridFunction)(\*\*kwargs) | | +| [`ShowMaximized`](#generated.RA3DWindow.ShowMaximized)() | Maximize the window, making it fill the entire screen space. | +| [`ShowMinimized`](#generated.RA3DWindow.ShowMinimized)() | Minimize the window, effectively hiding it from view and placing it in the taskbar | +| [`ShowModel`](#generated.RA3DWindow.ShowModel)([model_name]) | This function will activate the passed model. | +| [`ShowNodes`](#generated.RA3DWindow.ShowNodes)([name, model_name]) | Alias for SetNodesVisible(True, name, model_name) . | +| [`ShowNormal`](#generated.RA3DWindow.ShowNormal)() | Restore the window to its normal size, which is neither minimized nor maximized. | +| [`ShowParticleGridFunction`](#generated.RA3DWindow.ShowParticleGridFunction)(grid_function_name) | Change the particle coloring to the specified grid function. :param grid_function_name: The name of the grid function to be shown. It is possible to pass None to set back to solid color. | +| [`ShowSphGridFunction`](#generated.RA3DWindow.ShowSphGridFunction)(grid_function_name) | Change the SPH coloring to the specified grid function. :param grid_function_name: The name of the grid function to be shown. It is possible to pass None to set back to solid color. | +| [`Snapshot`](#generated.RA3DWindow.Snapshot)(filename[, width, height, ...]) | Take a snapshot from the window content and save it in the filename given. | + +**Attributes:** + +| Name | +| -------------------------------------- | +| [`app`](#generated.RA3DWindow.app) | + + + +#### ApplyGridFunctionToAll(grid_function_name: str | None) + +Change the coloring of all entities in this window to the specified grid function. +:param grid_function_name: + +> The name of the grid function to be shown. +> It is possible to pass None to set back to solid color. + + + +#### CloseWindow() + +Removes this window from the application. + + + +#### CreateAnimationKeyFrame(number_of_frames=None) + +Creates an animation key frame based on the current camera in the 3d window. + + + +#### ExportAnimation(filename, mode='video') + +* **Parameters:** + * **filename** (*str*) – The file to which the animation should be exported. If a video, the file + will be the actual path passed, if exporting as images will + * **mode** (*str*) – Whether the animation should be exported as a video or as images. + Accepted values: ‘video’, ‘images’. + + + +#### GetActiveSimulation() + +* **Return type:** + unicode +* **Returns:** + The name of the simulation being shown + + + +#### GetAnimationKeyFramesCount() + +* **Return int:** + Returns the number of key frames created for the given 3d window. + + + +#### GetCamera() + +Get the API wrapper for the 3D window’s camera. + +* **Return type:** + KACamera + + + +#### GetSize() + +* **Return type:** + tuple(int, int) +* **Returns:** + Returns the client window dimension (width, height) + + + +#### Hide(name, model_name=None) + +Alias for SetVisible(False, name, model_name) +.. seealso:: SetVisible + + + +#### HideEdges(name=None, model_name=None) + +Alias for SetEdgesVisible(False, name, model_name) +.. seealso:: SetEdgesVisible + + + +#### HideNodes(name=None, model_name=None) + +Alias for SetNodesVisible(False, name, model_name) +.. seealso:: SetNodesVisible + + + +#### RemoveAllAnimationKeyFrames() + +Removes all the currently created animation key frames in the current 3d window. + + + +#### Resize(width, height) + +Resize the 3D window to the given width and height. + + + +#### SetActiveSimulation(simulation_name) + +Changes the simulation being shown in the current 3D window + +* **Parameters:** + **simulation_name** (*unicode*) – The name of the simulation + + + +#### SetAnimationCameraInterpolation(interpolation) + +* **Parameters:** + **interpolation** (*str*) – + + The interpolation method to be used to interpolate camera parameters. + + Valid values are: + : ’linear’ + ‘spline’ + ‘no-interpolation’ + + + +#### SetAnimationFPS(fps) + +Sets the FPS (frames per second) to be used for the animation. + +Note that the time for the animation is based on the total number of frames and the FPS, so, +if there are 10 frames with an FPS of 2, the total time for the animation will be 5 seconds +as each second will have 2 frames. + +* **Parameters:** + **fps** (*int*) – The fps to be used for the animation. + + + +#### SetBackgroundColor(color) + +* **Parameters:** + **color** (*tuple* *(**int* *,* *int* *,* *int* *)* *,* *tuple* *(**float* *,* *float* *,* *float* *)* *,* *unicode* *,* *int*) – The color to be used as a background. + Either a tuple with values 0..255, or a tuple with values 0..1, the name of the color + or the RGB value as an integer. + + + +#### SetCameraPreset(preset='+X') + +Set the camera to one of the existing presets. + +* **Parameters:** + **preset** (*unicode*) – + + The preset to be set. + The valid presets are: + > - ’+X’ + > - ’-X’ + > - ’+X 30’ + > - ’+Y’ + > - ’-Y’ + > - ’+Y 30’ + > - ’+Z’ + > - ’-Z’ + + + +#### SetEdgesVisible(visible, name=None, model_name=None) + +Makes the edges visible or invisible in this window (changes either the global settings +for this window or the the passed grid, if the grid is not using the global settings). + +* **Parameters:** + * **visible** (*bool*) – Whether the edges should be made visible or invisible. + * **name** (*unicode*) – The name of the grid which should have the edges made visible or invisible. If not + passed, changes the configuration of the global window settings. + * **model_name** (*unicode*) – The name of the model which has the grid which should have the edges made visible or + invisible. + + + +#### SetForegroundColor(color) + +* **Parameters:** + **color** (*tuple* *(**int* *,* *int* *,* *int* *)* *,* *tuple* *(**float* *,* *float* *,* *float* *)* *,* *unicode* *,* *int*) – The color to be used as a foreground. + Either a tuple with values 0..255, or a tuple with values 0..1, the name of the color + or the RGB value as an integer. + + + +#### SetNodesVisible(visible, name=None, model_name=None) + +Makes the nodes visible or invisible in this window (changes either the global settings +for this window or the the passed grid, if the grid is not using the global settings). + +* **Parameters:** + * **visible** (*bool*) – Whether the nodes should be made visible or invisible. + * **name** (*unicode*) – The name of the grid which should have the nodes made visible or invisible. If not + passed, changes the configuration of the global window settings. + * **model_name** (*unicode*) – The name of the model which has the grid which should have the nodes made visible or + invisible. + + + +#### SetSelectedWindow(window_name=None) + +Sets the given window as the currently selected window. + +* **Parameters:** + **window_name** (*unicode*) – The name of the window that should be selected (if not passed, the window which has + this method called is selected). + + + +#### SetTransparency(transparency, name=None, model_name=None, enable_transparency=True) + +Sets the transparency for the given grid. + +* **Parameters:** + * **transparency** (*int*) – A number between 0 and 100, where 0 is completely transparent and 100 is completely + opaque. + * **name** (*unicode*) – The name of the grid which should have the transparency changed. + * **model_name** (*unicode*) – The name of the model which has the grid which should have the nodes made visible or + invisible. + * **enable_transparency** (*bool*) – Whether the transparency set should be used or not in the given grid. + + + +#### SetVisible(visible, name, model_name=None) + +Makes a given element visible or invisible within this window. + +* **Parameters:** + * **visible** (*bool*) – Whether the element should be made visible or invisible. + * **name** (*unicode*) – The name of the element to be made visible or invisible. + * **model_name** (*unicode*) – The model where the element is contained (if not passed, the current model is used). + + + +#### Show(name, model_name=None) + +Alias for SetVisible(True, name, model_name) +.. seealso:: SetVisible + + + +#### ShowEdges(name=None, model_name=None) + +Alias for SetEdgesVisible(True, name, model_name) +.. seealso:: SetEdgesVisible + + + +#### ShowGeometryGridFunction(grid_function_name: str | None) + +Change the coloring of all geometries in this window to the specified grid function. +:param grid_function_name: + +> The name of the grid function to be shown. +> It is possible to pass None to set back to solid color. + + + +#### ShowGridFunction(\*\*kwargs: object) + +* **Parameters:** + **grid_function_name** – The grid_function_name of the grid function to be shown. + + + +#### ShowMaximized() + +Maximize the window, making it fill the entire screen space. + + + +#### ShowMinimized() + +Minimize the window, effectively hiding it from view and placing it in the taskbar + + + +#### ShowModel(model_name=None) + +This function will activate the passed model. + +* **Parameters:** + **model_name** (*unicode*) – The name of the model that should be activated. + + + +#### ShowNodes(name=None, model_name=None) + +Alias for SetNodesVisible(True, name, model_name) +.. seealso:: SetNodesVisible + + + +#### ShowNormal() + +Restore the window to its normal size, which is neither minimized nor maximized. + + + +#### ShowParticleGridFunction(grid_function_name: str | None) + +Change the particle coloring to the specified grid function. +:param grid_function_name: + +> The name of the grid function to be shown. +> It is possible to pass None to set back to solid color. + + + +#### ShowSphGridFunction(grid_function_name: str | None) + +Change the SPH coloring to the specified grid function. +:param grid_function_name: + +> The name of the grid function to be shown. +> It is possible to pass None to set back to solid color. + + + +#### Snapshot(filename, width=None, height=None, magnification=None, keep_aspect_ratio=None) + +Take a snapshot from the window content and save it in the filename given. + +* **Parameters:** + * **filename** (*unicode*) – The file name to save the snapshot. + .. note:: the filename must contain the extension. e.g.: ‘../snapshot.png’ + * **width** (*int*) – The snapshot width (only used for plots, not 3d windows). + .. note:: the current window width is used if it is None + * **height** (*int*) – The snapshot height (only used for plots, not 3d windows). + .. note:: the current window height is used if it is None + * **magnification** (*int*) – An int value to multiply the snapshot size. + .. note:: if this parameter is specified, the width and height parameters are ignored. + * **keep_aspect_ratio** (*bool*) – Only used for plots, not 3d windows. + If True the current plot size is scaled to a rectangle as large as possible inside a + given rectangle (defined by the size given), keeping the aspect ratio. + + + +#### *property* app + +* **Return type:** + KAApplication +* **Returns:** + The application diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAAirFlow.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAAirFlow.md index c51e4c0155..5e6e20ca35 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAAirFlow.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAAirFlow.md @@ -54,10 +54,13 @@ airflow = cfd_coupling.GetAirFlow() | [`GetCurveNames`](#generated.RAAirFlow.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAAirFlow.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAAirFlow.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAAirFlow.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAAirFlow.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAAirFlow.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAAirFlow.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAAirFlow.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAAirFlow.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAAirFlow.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAAirFlow.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetInteractionScale`](#generated.RAAirFlow.GetInteractionScale)([unit]) | Get the value of "Interaction Scale". | | [`GetMaxX`](#generated.RAAirFlow.GetMaxX)([unit]) | Get the value of "Max X". | | [`GetMaxY`](#generated.RAAirFlow.GetMaxY)([unit]) | Get the value of "Max Y". | @@ -79,6 +82,7 @@ airflow = cfd_coupling.GetAirFlow() | [`GetTopologyShape`](#generated.RAAirFlow.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | | [`GetUseAirflow`](#generated.RAAirFlow.GetUseAirflow)() | Get the value of "Use Airflow". | | [`GetValidBoundaryConditionTypeValues`](#generated.RAAirFlow.GetValidBoundaryConditionTypeValues)() | Get a list of all possible values for "Boundary Condition Type". | +| [`GetVertices`](#generated.RAAirFlow.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAAirFlow.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAAirFlow.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAAirFlow.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -163,7 +167,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -175,7 +179,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -242,30 +246,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -458,16 +460,14 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -501,83 +501,73 @@ Get “Boundary Condition Type” as a string. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -586,39 +576,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -661,22 +647,20 @@ Get the value of “Cell Size”. -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -718,25 +702,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -758,13 +782,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -772,22 +794,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -827,7 +836,7 @@ Get the value of “Max Z”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -867,31 +876,27 @@ Get the value of “Min Z”. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -943,8 +948,6 @@ Get the value of “Start When Particles Enter”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -982,16 +985,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1010,46 +1011,57 @@ Get a list of all possible values for “Boundary Condition Type”. * **Returns:** The returned list is [‘first_derivative’, ‘second_derivative’]. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1059,12 +1071,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACFDCoupling.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACFDCoupling.md index c06d595608..ba7fd56b37 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACFDCoupling.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACFDCoupling.md @@ -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. | - - - -#### 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. | @@ -75,36 +62,6 @@ Returns None if the current CFD coupling mode isn’t Air Flow. * **Return type:** [RAAirFlow](RAAirFlow.md#generated.RAAirFlow) - - -#### SetupAirFlow() - -Deprecated: Use SetupOneWayLBM instead. - - - -#### SetupCFDConstantOneWayCouplingProcess() - -Deprecated: Use SetupOneWayConstant instead. - - - -#### SetupConstantOneWay() - -Deprecated: Use SetupOneWayConstant instead. - - - -#### SetupFluentOneWaySteadyState(f2r_filename: str) - -Deprecated: Use SetupOneWayFluent instead. - - - -#### SetupFluentTwoWay(cas_filename: str) - -Deprecated: Use SetupTwoWayFluent instead. - #### SetupFluentTwoWaySemiResolved(cas_filename: str) @@ -136,12 +93,6 @@ Configure the project to use 1-Way Fluent. **f2r_filename** – str The exported file name describing the Fluent simulation - - -#### SetupOneWayFluentSteadyState(f2r_filename: str) - -Deprecated: Use SetupOneWayFluent instead. - #### SetupOneWayLBM() diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACalculations.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACalculations.md index ffa2c945a0..9f1761522b 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACalculations.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACalculations.md @@ -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. | @@ -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 - - -#### CreateSelectionTagging(selection: RAGridProcessElementItem) - -Deprecated: Use [`CreateTagging()`](#generated.RACalculations.CreateTagging) instead. - #### CreateTagging(selection: RAGridProcessElementItem) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACircularSurface.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACircularSurface.md index 442f23268d..6ebf7e549b 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACircularSurface.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACircularSurface.md @@ -43,13 +43,17 @@ Rocky API for “Circular Surface” model. | [`GetCurveNames`](#generated.RACircularSurface.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RACircularSurface.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RACircularSurface.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RACircularSurface.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RACircularSurface.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RACircularSurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RACircularSurface.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RACircularSurface.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RACircularSurface.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RACircularSurface.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RACircularSurface.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMaxRadius`](#generated.RACircularSurface.GetMaxRadius)([unit]) | Get the value of "Max Radius". | | [`GetMeshColoring`](#generated.RACircularSurface.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMinRadius`](#generated.RACircularSurface.GetMinRadius)([unit]) | Get the value of "Min Radius". | +| [`GetMotionFrame`](#generated.RACircularSurface.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RACircularSurface.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RACircularSurface.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | | [`GetNumpyCurve`](#generated.RACircularSurface.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | @@ -62,6 +66,7 @@ Rocky API for “Circular Surface” model. | [`GetTimeStatistics`](#generated.RACircularSurface.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RACircularSurface.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RACircularSurface.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RACircularSurface.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RACircularSurface.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`HasMotionFrame`](#generated.RACircularSurface.HasMotionFrame)() | Whether the geometry is linked to a motion frame. | | [`IsCellActive`](#generated.RACircularSurface.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -76,6 +81,7 @@ Rocky API for “Circular Surface” model. | [`SetCurrentTimeStep`](#generated.RACircularSurface.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetMaxRadius`](#generated.RACircularSurface.SetMaxRadius)(value[, unit]) | Set the value of "Max Radius". | | [`SetMinRadius`](#generated.RACircularSurface.SetMinRadius)(value[, unit]) | Set the value of "Min Radius". | +| [`SetMotionFrame`](#generated.RACircularSurface.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | | [`SetOrientation`](#generated.RACircularSurface.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | | [`SetOrientationFromAngleAndVector`](#generated.RACircularSurface.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | | [`SetOrientationFromAngles`](#generated.RACircularSurface.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | @@ -138,7 +144,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -150,7 +156,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -217,30 +223,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -433,99 +437,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -534,39 +526,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -600,16 +588,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -624,7 +610,7 @@ Get the value of “Center”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -666,25 +652,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -706,13 +732,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -720,22 +744,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -748,7 +759,7 @@ Get the value of “Max Radius”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -768,33 +779,36 @@ Get the value of “Min Radius”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + +#### GetMotionFrame() + +* **Returns:** + The motion frame set in the process, or None if no motion is set. + -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -847,8 +861,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -886,29 +898,40 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -923,31 +946,29 @@ Whether the geometry is linked to a motion frame. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -957,12 +978,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1051,6 +1072,15 @@ Set the value of “Min Radius”. * **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”. + + +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) + +Assign a Motion Frame to the process. + +* **Parameters:** + **motion_frame** – Either the API object or its name. + #### SetOrientation(rotation: tuple[float, float, float], unit: str = 'dega') diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAConstantOneWayCoupling.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAConstantOneWayCoupling.md index 4c20ad69a2..ab27803ea8 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAConstantOneWayCoupling.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAConstantOneWayCoupling.md @@ -56,10 +56,13 @@ constant_one_way = cfd_coupling.GetCouplingProcess() | [`GetDensity`](#generated.RAConstantOneWayCoupling.GetDensity)([unit]) | Get the value of "Density". | | [`GetDragLaw`](#generated.RAConstantOneWayCoupling.GetDragLaw)() | Get the current "Drag Law". | | [`GetElementCurve`](#generated.RAConstantOneWayCoupling.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAConstantOneWayCoupling.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAConstantOneWayCoupling.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAConstantOneWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAConstantOneWayCoupling.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAConstantOneWayCoupling.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAConstantOneWayCoupling.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAConstantOneWayCoupling.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAConstantOneWayCoupling.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetLiftLaw`](#generated.RAConstantOneWayCoupling.GetLiftLaw)() | Get the current "Lift Law". | | [`GetMeshColoring`](#generated.RAConstantOneWayCoupling.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMorsiAndAlexanderK1`](#generated.RAConstantOneWayCoupling.GetMorsiAndAlexanderK1)() | Get the current "Morsi And Alexander K1". | @@ -85,6 +88,7 @@ constant_one_way = cfd_coupling.GetCouplingProcess() | [`GetUseTurbulentDispersion`](#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion)() | Get the value of "Use Turbulent Dispersion". | | [`GetUseUserDefinedConstants`](#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants)() | Get the current "Use User Defined Constants". | | [`GetVelocity`](#generated.RAConstantOneWayCoupling.GetVelocity)([unit]) | Get the value of "Velocity". | +| [`GetVertices`](#generated.RAConstantOneWayCoupling.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetVirtualMassLaw`](#generated.RAConstantOneWayCoupling.GetVirtualMassLaw)() | Get the current "Virtual Mass Law". | | [`GetViscosity`](#generated.RAConstantOneWayCoupling.GetViscosity)([unit]) | Get the value of "Viscosity". | | [`HasGridFunction`](#generated.RAConstantOneWayCoupling.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | @@ -178,7 +182,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -190,7 +194,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -257,30 +261,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -485,36 +487,32 @@ Set the value of “Turbulent Dispersion” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. @@ -528,65 +526,57 @@ Get the list of per-Particle CFD parameter sets. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -595,39 +585,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -661,16 +647,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -689,7 +673,7 @@ See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerP -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -753,25 +737,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -793,13 +817,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -807,22 +829,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -839,7 +848,7 @@ See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -891,31 +900,27 @@ See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticl -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1005,8 +1010,6 @@ Get the value of “Thermal Conductivity”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1044,16 +1047,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1116,6 +1117,21 @@ Get the value of “Velocity”. * **Parameters:** **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m/s”. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetVirtualMassLaw() @@ -1140,32 +1156,28 @@ Get the value of “Viscosity”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1177,13 +1189,13 @@ Check if the “Turbulent Dispersion” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1193,12 +1205,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactData.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactData.md index 0286dd351f..de4599f12f 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactData.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactData.md @@ -45,10 +45,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNames`](#generated.RAContactData.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAContactData.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAContactData.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAContactData.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAContactData.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAContactData.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAContactData.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAContactData.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAContactData.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAContactData.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAContactData.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetIncludeAdhesiveContacts`](#generated.RAContactData.GetIncludeAdhesiveContacts)() | Get the value of "Include Adhesive Contacts". | | [`GetMeshColoring`](#generated.RAContactData.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAContactData.GetNumberOfCells)([time_step]) | Get the total number of cells. | @@ -59,6 +62,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RAContactData.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAContactData.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAContactData.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAContactData.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAContactData.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAContactData.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IsCollectContactsDataEnabled`](#generated.RAContactData.IsCollectContactsDataEnabled)() | Check if the "Collect Contacts Data" is enabled. | @@ -131,7 +135,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -143,7 +147,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -210,30 +214,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -450,99 +452,87 @@ Set the value of “Include Adhesive Contacts” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -551,39 +541,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -617,16 +603,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -638,7 +622,7 @@ Get the value of “Collect Contacts Data”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -680,25 +664,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -720,13 +744,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -734,22 +756,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -759,7 +768,7 @@ Get the value of “Include Adhesive Contacts”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -772,31 +781,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -824,8 +829,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -863,47 +866,56 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -921,13 +933,13 @@ Check if the “Include Adhesive Contacts” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -937,12 +949,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactToParticleProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactToParticleProcess.md index bdfc86d94d..90df8edd5f 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactToParticleProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAContactToParticleProcess.md @@ -42,10 +42,13 @@ Process that computes particles from a selection of contacts. | [`GetCurveNames`](#generated.RAContactToParticleProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAContactToParticleProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAContactToParticleProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAContactToParticleProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAContactToParticleProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAContactToParticleProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAContactToParticleProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAContactToParticleProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAContactToParticleProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAContactToParticleProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAContactToParticleProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAContactToParticleProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAContactToParticleProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAContactToParticleProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -56,6 +59,7 @@ Process that computes particles from a selection of contacts. | [`GetTimeStatistics`](#generated.RAContactToParticleProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAContactToParticleProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAContactToParticleProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAContactToParticleProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAContactToParticleProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAContactToParticleProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAContactToParticleProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -125,7 +129,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -137,7 +141,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -204,30 +208,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -420,99 +422,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -521,39 +511,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -587,22 +573,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -644,25 +628,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -684,13 +708,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -698,26 +720,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -730,31 +739,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -797,8 +802,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -836,59 +839,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -898,12 +910,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACoupledWall.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACoupledWall.md index b92b6e7b00..ce04ce1fdb 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACoupledWall.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACoupledWall.md @@ -45,14 +45,18 @@ Rocky API Geometry model. | [`GetDisableTime`](#generated.RACoupledWall.GetDisableTime)([unit]) | Get the value of "Disable Time". | | [`GetElementCurve`](#generated.RACoupledWall.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | | [`GetEnableTime`](#generated.RACoupledWall.GetEnableTime)([unit]) | Get the value of "Enable Time". | +| [`GetFacePositions`](#generated.RACoupledWall.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RACoupledWall.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RACoupledWall.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RACoupledWall.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RACoupledWall.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RACoupledWall.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RACoupledWall.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RACoupledWall.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMaterial`](#generated.RACoupledWall.GetMaterial)() | Get the "Material". | | [`GetMeshColoring`](#generated.RACoupledWall.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetModuleProperties`](#generated.RACoupledWall.GetModuleProperties)() | Get the names of the module properties. | | [`GetModuleProperty`](#generated.RACoupledWall.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetMotionFrame`](#generated.RACoupledWall.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RACoupledWall.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RACoupledWall.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | | [`GetNumpyCurve`](#generated.RACoupledWall.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | @@ -62,6 +66,7 @@ Rocky API Geometry model. | [`GetTimeStep`](#generated.RACoupledWall.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RACoupledWall.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | | [`GetValidOptionsForModuleProperty`](#generated.RACoupledWall.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`GetVertices`](#generated.RACoupledWall.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RACoupledWall.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`HasMotionFrame`](#generated.RACoupledWall.HasMotionFrame)() | Whether the boundary is linked to a motion frame. | | [`IsCellActive`](#generated.RACoupledWall.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -77,6 +82,7 @@ Rocky API Geometry model. | [`SetEnableTime`](#generated.RACoupledWall.SetEnableTime)(value[, unit]) | Set the value of "Enable Time". | | [`SetMaterial`](#generated.RACoupledWall.SetMaterial)(value) | Set the "Material". | | [`SetModuleProperty`](#generated.RACoupledWall.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetMotionFrame`](#generated.RACoupledWall.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | @@ -135,7 +141,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -147,7 +153,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -214,30 +220,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -430,16 +434,14 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -456,83 +458,73 @@ Get all available Materials. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -541,39 +533,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -607,22 +595,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -682,25 +668,65 @@ Get the value of “Enable Time”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -722,13 +748,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -736,22 +760,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -764,7 +775,7 @@ Get the “Material”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -803,33 +814,36 @@ Get the value of a module property. - For properties that are lists of other properties, the returned value is a : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). + + +#### GetMotionFrame() + +* **Returns:** + The motion frame set in the process, or None if no motion is set. + -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -857,8 +871,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -896,16 +908,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -920,16 +930,29 @@ Get all valid options only for properties that have a list of possible options. * **Return type:** List[str] + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -944,31 +967,29 @@ Whether the boundary is linked to a motion frame. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -978,12 +999,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1080,3 +1101,12 @@ Set the value of a module property. If the property_name references to an enum property then value must be an str value. * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, value is assumed to be the unit was set before. + + + +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) + +Assign a Motion Frame to the process. + +* **Parameters:** + **motion_frame** – Either the API object or its name. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeGroup.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeGroup.md index 39787d518b..12114c5f3a 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeGroup.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeGroup.md @@ -200,7 +200,7 @@ Sets the cube X, Y and Z center -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeProcess.md index 8ed850c822..96c236a571 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACubeProcess.md @@ -38,17 +38,17 @@ generally aren't instantiated by the user). --> | [`GetCellVolumeAsArray`](#generated.RACubeProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | | [`GetCenter`](#generated.RACubeProcess.GetCenter)([unit]) | | | [`GetCenterAfterMovement`](#generated.RACubeProcess.GetCenterAfterMovement)(timestep) | Get the Process center position considering the assigned motion. | -| [`GetCubeCenter`](#generated.RACubeProcess.GetCubeCenter)([unit]) | Deprecated: Use GetCenter instead | -| [`GetCubeMagnitude`](#generated.RACubeProcess.GetCubeMagnitude)([unit]) | Deprecated: Use GetSize instead | -| [`GetCubeRotation`](#generated.RACubeProcess.GetCubeRotation)([unit]) | Deprecated: Use GetRotation instead | | [`GetCurve`](#generated.RACubeProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | | [`GetCurveNames`](#generated.RACubeProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RACubeProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RACubeProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RACubeProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RACubeProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RACubeProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RACubeProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RACubeProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RACubeProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RACubeProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RACubeProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RACubeProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMotionFrame`](#generated.RACubeProcess.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RACubeProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | @@ -66,6 +66,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RACubeProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RACubeProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RACubeProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RACubeProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RACubeProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RACubeProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RACubeProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -77,9 +78,6 @@ generally aren't instantiated by the user). --> | [`RemoveOutputVariable`](#generated.RACubeProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | | [`RemoveProcess`](#generated.RACubeProcess.RemoveProcess)() | Removes the process from the project. | | [`SetCenter`](#generated.RACubeProcess.SetCenter)(x, y, z[, unit]) | Sets the cube X, Y and Z center | -| [`SetCubeCenter`](#generated.RACubeProcess.SetCubeCenter)(x, y, z[, unit]) | Deprecated: Use SetCenter instead | -| [`SetCubeMagnitude`](#generated.RACubeProcess.SetCubeMagnitude)(x, y, z[, unit]) | Deprecated: Use SetSize instead | -| [`SetCubeRotation`](#generated.RACubeProcess.SetCubeRotation)(x, y, z[, unit]) | Deprecated: Use SetRotation instead | | [`SetCurrentTimeStep`](#generated.RACubeProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetMotionFrame`](#generated.RACubeProcess.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | | [`SetOrientation`](#generated.RACubeProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | @@ -146,7 +144,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -158,7 +156,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -225,30 +223,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -441,99 +437,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -542,39 +526,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -608,16 +588,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -639,27 +617,9 @@ Get the Process center position considering the assigned motion. * **Returns:** Returns the X, Y and Z center - - -#### GetCubeCenter(unit=None) - -Deprecated: Use GetCenter instead - - - -#### GetCubeMagnitude(unit=None) - -Deprecated: Use GetSize instead - - - -#### GetCubeRotation(unit=None) - -Deprecated: Use GetRotation instead - -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -701,25 +661,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -741,13 +741,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -755,26 +753,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -794,31 +779,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -904,8 +885,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -943,59 +922,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1005,12 +993,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1089,24 +1077,6 @@ Sets the cube X, Y and Z center * **z** – The center Z coordinate * **unit** (*str* *|**None*) – The unit of the given values or None if given in meters (m) - - -#### SetCubeCenter(x, y, z, unit=None) - -Deprecated: Use SetCenter instead - - - -#### SetCubeMagnitude(x, y, z, unit=None) - -Deprecated: Use SetSize instead - - - -#### SetCubeRotation(x, y, z, unit=None) - -Deprecated: Use SetRotation instead - #### SetCurrentTimeStep(time_step) @@ -1118,7 +1088,7 @@ Sets the current time step. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACurve.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACurve.md new file mode 100644 index 0000000000..ae0b3bd019 --- /dev/null +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACurve.md @@ -0,0 +1,256 @@ + + +# RACurve + + + + + + +### *class* RACurve + +**Methods:** + +| Name | Description | +|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| [`CrossFromAbove`](#generated.RACurve.CrossFromAbove)(threshold[, result]) | Returns the domain values where *y* crosses some threshold from above X's where. | +| [`CrossFromBellow`](#generated.RACurve.CrossFromBellow)(threshold[, result]) | Returns the domain values where *y* crosses some threshold from bellow X's where. | +| [`GetStatistics`](#generated.RACurve.GetStatistics)() | @return: IStatistics | +| [`GetTimeSet`](#generated.RACurve.GetTimeSet)() | @return: ITimeSet | +| [`GetUnit`](#generated.RACurve.GetUnit)() | @return: unicode | +| [`GetX`](#generated.RACurve.GetX)() | @return: list(float) or ITimeSet) | +| [`GetXUnit`](#generated.RACurve.GetXUnit)() | @return: unicode | +| [`GetY`](#generated.RACurve.GetY)() | @return: list(float or ITimeStep) | +| [`Interpolate`](#generated.RACurve.Interpolate)(x_value) | Returns the piecewise linear interpolation with given value at discrete data-points. | +| [`Reset`](#generated.RACurve.Reset)() | Reset all changes to its default values | +| [`SetFrequency`](#generated.RACurve.SetFrequency)(days[, extend]) | Change the domain frequency | +| [`SetUnit`](#generated.RACurve.SetUnit)(unit) | Change the unit of the curve image values (y) | +| [`SetXUnit`](#generated.RACurve.SetXUnit)(unit) | Change the unit of the curve image values (y) | + +**Attributes:** + +| Name | Description | +|---------------------------------------------------------|-----------------------------------| +| [`curve_name`](#generated.RACurve.curve_name) | @return: unicode | +| [`element_name`](#generated.RACurve.element_name) | @return: unicode | +| [`simulation_name`](#generated.RACurve.simulation_name) | @return: unicode | +| [`unit`](#generated.RACurve.unit) | @return: unicode | +| [`x`](#generated.RACurve.x) | @return: list(float) or ITimeSet) | +| [`x_unit`](#generated.RACurve.x_unit) | @return: unicode | +| [`y`](#generated.RACurve.y) | @return: list(float or ITimeStep) | + + + +#### CrossFromAbove(threshold, result=None) + +Returns the domain values where *y* crosses some threshold from above +X’s where: + +```default +y[i-1]>threshold and y[i]<=threshold +``` + +@param threshold: float +: The threshold value in the image + +@param result: ‘left’, ‘right’ or ‘interp’ +: Which result should be returned + ‘left’ will return the x value on the left side of the interval + ‘right’ will return the x value on the right side of the interval + ‘interp’ will return the x value of the linear interpolation of the interval + +@note: If no result type is given an interpolation will be used + +@return: list(float or TimeStep) +: A list of the domain values + + + +#### CrossFromBellow(threshold, result=None) + +Returns the domain values where *y* crosses some threshold from bellow +X’s where: + +```default +y[i-1]=threshold +``` + +@param threshold: float +: The threshold value in the image + +@param result: ‘left’, ‘right’ or ‘interp’ +: Which result should be returned + ‘left’ will return the x value on the left side of the interval + ‘right’ will return the x value on the right side of the interval + ‘interp’ will return the x value of the linear interpolation of the interval + +@note: If no result type is given an interpolation will be used + +@return: list(float or TimeStep) +: A list of the domain values + + + +#### GetStatistics() + +@return: IStatistics +: An object will the curve statistics information. + +@note: Usage +: #Minimum value + statistics.min +
+ #Maximum value + statistics.max +
+ #Sum of all the values + statistics.sum +
+ #Sum squared of all the values + statistics.sum_squared +
+ #Average of the values + statistics.average +
+ #Variance of the values + statistics.variance +
+ #Standard deviation of the values + statistics.standard_deviation + + + +#### GetTimeSet() + +@return: ITimeSet +: The time set domain + + + +#### GetUnit() + +@return: unicode +: The unit of the curve image values (y) + + + +#### GetX() + +@return: list(float) or ITimeSet) +: The list of values associated with the domain + If a different unit is defined a conversion will take place + + + +#### GetXUnit() + +@return: unicode +: The unit of the curve image values (y) + + + +#### GetY() + +@return: list(float or ITimeStep) +: The list of values associated with the domain + If a different unit is defined a conversion will take place + + + +#### Interpolate(x_value) + +Returns the piecewise linear interpolation with given value at discrete data-points. + +@param x_value: float, tuple or TimeStep +: A float defining the elapsed time-step in days + A tuple with the year, month, day and optionally the hour and minutes + Or a TimeStep + + + +#### Reset() + +Reset all changes to its default values + + + +#### SetFrequency(days, extend=None) + +Change the domain frequency + +@param days: float +: The frequency in days + +@param extend: bool, optional +: If a last value should be included even if outisde the domain + + + +#### SetUnit(unit) + +Change the unit of the curve image values (y) + +@param unit: unicode +: The unit to be set + + + +#### SetXUnit(unit) + +Change the unit of the curve image values (y) + +@param unit: unicode +: The unit to be set + + + +#### *property* curve_name + +@return: unicode +: The name of the element associated to this curve + + + +#### *property* element_name + +@return: unicode +: The name of the element associated to this curve + + + +#### *property* simulation_name + +@return: unicode +: The name of the element associated to this curve + + + +#### *property* unit + +@return: unicode +: The unit of the curve image values (y) + + + +#### *property* x + +@return: list(float) or ITimeSet) +: The list of values associated with the domain + If a different unit is defined a conversion will take place + + + +#### *property* x_unit + +@return: unicode +: The unit of the curve image values (y) + + + +#### *property* y + +@return: list(float or ITimeStep) +: The list of values associated with the domain + If a different unit is defined a conversion will take place diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderGroup.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderGroup.md index 017840784f..bbecbb3280 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderGroup.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderGroup.md @@ -263,7 +263,7 @@ Sets the internal hole radius factor of the external given by the size -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderProcess.md index 9e97938641..99661104b3 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RACylinderProcess.md @@ -42,11 +42,14 @@ generally aren't instantiated by the user). --> | [`GetCurveNames`](#generated.RACylinderProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RACylinderProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RACylinderProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RACylinderProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RACylinderProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFinalAngle`](#generated.RACylinderProcess.GetFinalAngle)([unit]) | | | [`GetGeometryQuantity`](#generated.RACylinderProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RACylinderProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RACylinderProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RACylinderProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RACylinderProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RACylinderProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetInitialAngle`](#generated.RACylinderProcess.GetInitialAngle)([unit]) | | | [`GetInternalFactor`](#generated.RACylinderProcess.GetInternalFactor)([unit]) | | | [`GetMeshColoring`](#generated.RACylinderProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | @@ -66,6 +69,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RACylinderProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RACylinderProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RACylinderProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RACylinderProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RACylinderProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RACylinderProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RACylinderProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -146,7 +150,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -158,7 +162,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -225,30 +229,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -441,99 +443,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -542,39 +532,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -608,16 +594,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -641,7 +625,7 @@ Get the Process center position considering the assigned motion. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -683,6 +667,35 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFinalAngle(unit=None) @@ -697,19 +710,30 @@ Return the curves for the given element and name. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -731,13 +755,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -745,22 +767,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -780,7 +789,7 @@ Get a list of the available grid functions for this grid. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -800,31 +809,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -910,8 +915,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -949,59 +952,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1011,12 +1023,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1139,7 +1151,7 @@ Sets the internal hole radius factor of the external given by the size -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RADomainSettings.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RADomainSettings.md index 1eba772ea0..2948b9768e 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RADomainSettings.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RADomainSettings.md @@ -23,41 +23,39 @@ domain_settings = study.GetDomainSettings() **Methods:** | Name | Description | -|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| [`DisablePeriodicAtGeometryLimits`](#generated.RADomainSettings.DisablePeriodicAtGeometryLimits)() | Set the value of "Periodic At Geometry Limits" to False. | -| [`DisableUseBoundaryLimits`](#generated.RADomainSettings.DisableUseBoundaryLimits)() | Set the value of "Use Boundary Limits" to False. | -| [`EnablePeriodicAtGeometryLimits`](#generated.RADomainSettings.EnablePeriodicAtGeometryLimits)() | Set the value of "Periodic At Geometry Limits" to True. | -| [`EnableUseBoundaryLimits`](#generated.RADomainSettings.EnableUseBoundaryLimits)() | Set the value of "Use Boundary Limits" to True. | -| [`GetBoundariesDirections`](#generated.RADomainSettings.GetBoundariesDirections)() | Deprecated: use GetCartesianPeriodicDirections() instead. | -| [`GetCartesianPeriodicDirections`](#generated.RADomainSettings.GetCartesianPeriodicDirections)() | Get "Cartesian Periodic Directions" as a string. | -| [`GetCoordinateLimitsMaxValues`](#generated.RADomainSettings.GetCoordinateLimitsMaxValues)([unit]) | Get the value of "Coordinate Limits Max Values". | -| [`GetCoordinateLimitsMinValues`](#generated.RADomainSettings.GetCoordinateLimitsMinValues)([unit]) | Get the value of "Coordinate Limits Min Values". | -| [`GetCylindricalPeriodicDirections`](#generated.RADomainSettings.GetCylindricalPeriodicDirections)() | Get "Cylindrical Periodic Directions" as a string. | -| [`GetDomainType`](#generated.RADomainSettings.GetDomainType)() | Get "Domain Type" as a string. | -| [`GetInitialAngle`](#generated.RADomainSettings.GetInitialAngle)([unit]) | Get the value of "Initial Angle". | -| [`GetNumberOfDivisions`](#generated.RADomainSettings.GetNumberOfDivisions)() | Get the value of "Number of Divisions". | -| [`GetPeriodicAtGeometryLimits`](#generated.RADomainSettings.GetPeriodicAtGeometryLimits)() | Get the value of "Periodic At Geometry Limits". | -| [`GetPeriodicLimitsMaxCoordinates`](#generated.RADomainSettings.GetPeriodicLimitsMaxCoordinates)([unit]) | Get the value of "Periodic Limits Max Coordinates". | -| [`GetPeriodicLimitsMinCoordinates`](#generated.RADomainSettings.GetPeriodicLimitsMinCoordinates)([unit]) | Get the value of "Periodic Limits Min Coordinates". | -| [`GetUseBoundaryLimits`](#generated.RADomainSettings.GetUseBoundaryLimits)() | Get the value of "Use Boundary Limits". | -| [`GetValidBoundariesDirectionsValues`](#generated.RADomainSettings.GetValidBoundariesDirectionsValues)() | Deprecated: use GetValidPeriodicDirectionsValues() instead. | -| [`GetValidCartesianPeriodicDirectionsValues`](#generated.RADomainSettings.GetValidCartesianPeriodicDirectionsValues)() | Get a list of all possible values for "Cartesian Periodic Directions". | -| [`GetValidCylindricalPeriodicDirectionsValues`](#generated.RADomainSettings.GetValidCylindricalPeriodicDirectionsValues)() | Get a list of all possible values for "Cylindrical Periodic Directions". | -| [`GetValidDomainTypeValues`](#generated.RADomainSettings.GetValidDomainTypeValues)() | Get a list of all possible values for "Domain Type". | -| [`IsPeriodicAtGeometryLimitsEnabled`](#generated.RADomainSettings.IsPeriodicAtGeometryLimitsEnabled)() | Check if the "Periodic At Geometry Limits" is enabled. | -| [`IsUseBoundaryLimitsEnabled`](#generated.RADomainSettings.IsUseBoundaryLimitsEnabled)() | Check if the "Use Boundary Limits" is enabled. | -| [`SetBoundariesDirections`](#generated.RADomainSettings.SetBoundariesDirections)(value) | Deprecated: use SetCartesianPeriodicDirections(value) instead. | -| [`SetCartesianPeriodicDirections`](#generated.RADomainSettings.SetCartesianPeriodicDirections)(value) | Set the value of "Cartesian Periodic Directions". | -| [`SetCoordinateLimitsMaxValues`](#generated.RADomainSettings.SetCoordinateLimitsMaxValues)(values[, unit]) | Set the values of "Coordinate Limits Max Values". | -| [`SetCoordinateLimitsMinValues`](#generated.RADomainSettings.SetCoordinateLimitsMinValues)(values[, unit]) | Set the values of "Coordinate Limits Min Values". | -| [`SetCylindricalPeriodicDirections`](#generated.RADomainSettings.SetCylindricalPeriodicDirections)(value) | Set the value of "Cylindrical Periodic Directions". | -| [`SetDomainType`](#generated.RADomainSettings.SetDomainType)(value) | Set the value of "Domain Type". | -| [`SetInitialAngle`](#generated.RADomainSettings.SetInitialAngle)(value[, unit]) | Set the value of "Initial Angle". | -| [`SetNumberOfDivisions`](#generated.RADomainSettings.SetNumberOfDivisions)(value) | Set the value of "Number of Divisions". | -| [`SetPeriodicAtGeometryLimits`](#generated.RADomainSettings.SetPeriodicAtGeometryLimits)(value) | Set the value of "Periodic At Geometry Limits". | -| [`SetPeriodicLimitsMaxCoordinates`](#generated.RADomainSettings.SetPeriodicLimitsMaxCoordinates)(values[, unit]) | Set the values of "Periodic Limits Max Coordinates". | -| [`SetPeriodicLimitsMinCoordinates`](#generated.RADomainSettings.SetPeriodicLimitsMinCoordinates)(values[, unit]) | Set the values of "Periodic Limits Min Coordinates". | -| [`SetUseBoundaryLimits`](#generated.RADomainSettings.SetUseBoundaryLimits)(value) | Set the value of "Use Boundary Limits". | +|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [`DisablePeriodicAtGeometryLimits`](#generated.RADomainSettings.DisablePeriodicAtGeometryLimits)() | Set the value of "Periodic At Geometry Limits" to False. | +| [`DisableUseBoundaryLimits`](#generated.RADomainSettings.DisableUseBoundaryLimits)() | Set the value of "Use Boundary Limits" to False. | +| [`EnablePeriodicAtGeometryLimits`](#generated.RADomainSettings.EnablePeriodicAtGeometryLimits)() | Set the value of "Periodic At Geometry Limits" to True. | +| [`EnableUseBoundaryLimits`](#generated.RADomainSettings.EnableUseBoundaryLimits)() | Set the value of "Use Boundary Limits" to True. | +| [`GetCartesianPeriodicDirections`](#generated.RADomainSettings.GetCartesianPeriodicDirections)() | Get "Cartesian Periodic Directions" as a string. | +| [`GetCoordinateLimitsMaxValues`](#generated.RADomainSettings.GetCoordinateLimitsMaxValues)([unit]) | Get the value of "Coordinate Limits Max Values". | +| [`GetCoordinateLimitsMinValues`](#generated.RADomainSettings.GetCoordinateLimitsMinValues)([unit]) | Get the value of "Coordinate Limits Min Values". | +| [`GetCylindricalPeriodicDirections`](#generated.RADomainSettings.GetCylindricalPeriodicDirections)() | Get "Cylindrical Periodic Directions" as a string. | +| [`GetDomainType`](#generated.RADomainSettings.GetDomainType)() | Get "Domain Type" as a string. | +| [`GetInitialAngle`](#generated.RADomainSettings.GetInitialAngle)([unit]) | Get the value of "Initial Angle". | +| [`GetNumberOfDivisions`](#generated.RADomainSettings.GetNumberOfDivisions)() | Get the value of "Number of Divisions". | +| [`GetPeriodicAtGeometryLimits`](#generated.RADomainSettings.GetPeriodicAtGeometryLimits)() | Get the value of "Periodic At Geometry Limits". | +| [`GetPeriodicLimitsMaxCoordinates`](#generated.RADomainSettings.GetPeriodicLimitsMaxCoordinates)([unit]) | Get the value of "Periodic Limits Max Coordinates". | +| [`GetPeriodicLimitsMinCoordinates`](#generated.RADomainSettings.GetPeriodicLimitsMinCoordinates)([unit]) | Get the value of "Periodic Limits Min Coordinates". | +| [`GetUseBoundaryLimits`](#generated.RADomainSettings.GetUseBoundaryLimits)() | Get the value of "Use Boundary Limits". | +| [`GetValidCartesianPeriodicDirectionsValues`](#generated.RADomainSettings.GetValidCartesianPeriodicDirectionsValues)() | Get a list of all possible values for "Cartesian Periodic Directions". | +| [`GetValidCylindricalPeriodicDirectionsValues`](#generated.RADomainSettings.GetValidCylindricalPeriodicDirectionsValues)() | Get a list of all possible values for "Cylindrical Periodic Directions". | +| [`GetValidDomainTypeValues`](#generated.RADomainSettings.GetValidDomainTypeValues)() | Get a list of all possible values for "Domain Type". | +| [`IsPeriodicAtGeometryLimitsEnabled`](#generated.RADomainSettings.IsPeriodicAtGeometryLimitsEnabled)() | Check if the "Periodic At Geometry Limits" is enabled. | +| [`IsUseBoundaryLimitsEnabled`](#generated.RADomainSettings.IsUseBoundaryLimitsEnabled)() | Check if the "Use Boundary Limits" is enabled. | +| [`ResetDomainToGeometriesLimits`](#generated.RADomainSettings.ResetDomainToGeometriesLimits)() | Reset the domain settings coordinate limits based on the geometry bounding box. | +| [`SetCartesianPeriodicDirections`](#generated.RADomainSettings.SetCartesianPeriodicDirections)(value) | Set the value of "Cartesian Periodic Directions". | +| [`SetCoordinateLimitsMaxValues`](#generated.RADomainSettings.SetCoordinateLimitsMaxValues)(values[, unit]) | Set the values of "Coordinate Limits Max Values". | +| [`SetCoordinateLimitsMinValues`](#generated.RADomainSettings.SetCoordinateLimitsMinValues)(values[, unit]) | Set the values of "Coordinate Limits Min Values". | +| [`SetCylindricalPeriodicDirections`](#generated.RADomainSettings.SetCylindricalPeriodicDirections)(value) | Set the value of "Cylindrical Periodic Directions". | +| [`SetDomainType`](#generated.RADomainSettings.SetDomainType)(value) | Set the value of "Domain Type". | +| [`SetInitialAngle`](#generated.RADomainSettings.SetInitialAngle)(value[, unit]) | Set the value of "Initial Angle". | +| [`SetNumberOfDivisions`](#generated.RADomainSettings.SetNumberOfDivisions)(value) | Set the value of "Number of Divisions". | +| [`SetPeriodicAtGeometryLimits`](#generated.RADomainSettings.SetPeriodicAtGeometryLimits)(value) | Set the value of "Periodic At Geometry Limits". | +| [`SetPeriodicLimitsMaxCoordinates`](#generated.RADomainSettings.SetPeriodicLimitsMaxCoordinates)(values[, unit]) | Set the values of "Periodic Limits Max Coordinates". | +| [`SetPeriodicLimitsMinCoordinates`](#generated.RADomainSettings.SetPeriodicLimitsMinCoordinates)(values[, unit]) | Set the values of "Periodic Limits Min Coordinates". | +| [`SetUseBoundaryLimits`](#generated.RADomainSettings.SetUseBoundaryLimits)(value) | Set the value of "Use Boundary Limits". | @@ -83,12 +81,6 @@ Set the value of “Periodic At Geometry Limits” to True. Set the value of “Use Boundary Limits” to True. - - -#### GetBoundariesDirections() - -Deprecated: use GetCartesianPeriodicDirections() instead. - #### GetCartesianPeriodicDirections() @@ -179,12 +171,6 @@ Get the value of “Periodic Limits Min Coordinates”. Get the value of “Use Boundary Limits”. - - -#### GetValidBoundariesDirectionsValues() - -Deprecated: use GetValidPeriodicDirectionsValues() instead. - #### GetValidCartesianPeriodicDirectionsValues() @@ -224,11 +210,11 @@ Check if the “Periodic At Geometry Limits” is enabled. Check if the “Use Boundary Limits” is enabled. - + -#### SetBoundariesDirections(value) +#### ResetDomainToGeometriesLimits() -Deprecated: use SetCartesianPeriodicDirections(value) instead. +Reset the domain settings coordinate limits based on the geometry bounding box. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAEulerianStatistics.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAEulerianStatistics.md index 9b2edc2cfb..9261b038a3 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAEulerianStatistics.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAEulerianStatistics.md @@ -43,10 +43,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNamesAssociation`](#generated.RAEulerianStatistics.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetDivisions`](#generated.RAEulerianStatistics.GetDivisions)() | Get the number of divisions in i/j/k. | | [`GetElementCurve`](#generated.RAEulerianStatistics.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAEulerianStatistics.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAEulerianStatistics.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAEulerianStatistics.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAEulerianStatistics.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAEulerianStatistics.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAEulerianStatistics.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAEulerianStatistics.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAEulerianStatistics.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAEulerianStatistics.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAEulerianStatistics.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAEulerianStatistics.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -58,6 +61,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RAEulerianStatistics.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAEulerianStatistics.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAEulerianStatistics.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAEulerianStatistics.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAEulerianStatistics.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAEulerianStatistics.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAEulerianStatistics.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -128,7 +132,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -140,7 +144,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -207,7 +211,7 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateEulerianGridFunction(operation_name: str, value_name: str, weight_name: str | None = None) +#### CreateEulerianGridFunction(operation_name: str, value_name: str, weight_name: str | None = None, grid_function_source: None | RAGridProcessElementItem = None) Add a new grid function to the Eulerian Statistics. @@ -227,34 +231,32 @@ grid function. The grid function PrePost Scripting wrapper is returned. * **weight_name** – The name of the second particle grid function to be used (the “weight”). Only used for operations that take two grid functions. Must be one of GetParticleGridFunctionNames(). * **Return type:** - KAGridFunction + [RAGridFunction](RAGridFunction.md#generated.RAGridFunction) -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -447,16 +449,14 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -472,83 +472,73 @@ Get a list with the operations that can be passed to CreateGridFunction(). -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -557,39 +547,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -623,22 +609,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -689,25 +673,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -729,13 +753,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -743,26 +765,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -775,31 +784,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -851,8 +856,6 @@ Get a list with the particle grid function names that can be passed to CreateGri Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -890,59 +893,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -952,12 +964,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFeedConveyor.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFeedConveyor.md index 282f547766..0bff7e14a1 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFeedConveyor.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFeedConveyor.md @@ -41,6 +41,7 @@ Rocky api Feed Conveyor model. | [`GetBeltThickness`](#generated.RAFeedConveyor.GetBeltThickness)([unit]) | Get the value of "Belt Thickness". | | [`GetBeltWidth`](#generated.RAFeedConveyor.GetBeltWidth)([unit]) | Get the value of "Belt Width". | | [`GetBoundingBox`](#generated.RAFeedConveyor.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCapillaryFrictionCoefficient`](#generated.RAFeedConveyor.GetCapillaryFrictionCoefficient)() | Get the value of "Capillary Friction Coefficient". | | [`GetCellAreaAsArray`](#generated.RAFeedConveyor.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | | [`GetCellCenterAsArray`](#generated.RAFeedConveyor.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | | [`GetCellDzAsArray`](#generated.RAFeedConveyor.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | @@ -58,12 +59,15 @@ Rocky api Feed Conveyor model. | [`GetDropBoxLength`](#generated.RAFeedConveyor.GetDropBoxLength)([unit]) | Get the value of "Drop Box Length". | | [`GetDropBoxWidth`](#generated.RAFeedConveyor.GetDropBoxWidth)([unit]) | Get the value of "Drop Box Width". | | [`GetElementCurve`](#generated.RAFeedConveyor.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAFeedConveyor.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAFeedConveyor.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFaceWidth`](#generated.RAFeedConveyor.GetFaceWidth)([unit]) | Get the value of "Face Width". | | [`GetFrontPlateOffset`](#generated.RAFeedConveyor.GetFrontPlateOffset)([unit]) | Get the value of "Front Plate Offset". | | [`GetGeometryQuantity`](#generated.RAFeedConveyor.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAFeedConveyor.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAFeedConveyor.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAFeedConveyor.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAFeedConveyor.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAFeedConveyor.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetHeightOffset`](#generated.RAFeedConveyor.GetHeightOffset)([unit]) | Get the value of "Height Offset". | | [`GetHorizontalOffset`](#generated.RAFeedConveyor.GetHorizontalOffset)([unit]) | Get the value of "Horizontal Offset". | | [`GetLengthOffset`](#generated.RAFeedConveyor.GetLengthOffset)([unit]) | Get the value of "Length Offset". | @@ -96,6 +100,7 @@ Rocky api Feed Conveyor model. | [`GetValidSphBoundaryTypeValues`](#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues)() | Get a list of all possible values for "Sph Boundary Type". | | [`GetValidThermalBoundaryConditionTypeValues`](#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues)() | Get a list of all possible values for "Thermal Boundary Condition Type". | | [`GetVerticalOffset`](#generated.RAFeedConveyor.GetVerticalOffset)([unit]) | Get the value of "Vertical Offset". | +| [`GetVertices`](#generated.RAFeedConveyor.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetWallThickness`](#generated.RAFeedConveyor.GetWallThickness)([unit]) | Get the value of "Wall Thickness". | | [`GetWidth`](#generated.RAFeedConveyor.GetWidth)([unit]) | Get the value of "Width". | | [`HasGridFunction`](#generated.RAFeedConveyor.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | @@ -116,6 +121,7 @@ Rocky api Feed Conveyor model. | [`SetBeltSpeed`](#generated.RAFeedConveyor.SetBeltSpeed)(value[, unit]) | Set the value of "Belt Speed". | | [`SetBeltThickness`](#generated.RAFeedConveyor.SetBeltThickness)(value[, unit]) | Set the value of "Belt Thickness". | | [`SetBeltWidth`](#generated.RAFeedConveyor.SetBeltWidth)(value[, unit]) | Set the value of "Belt Width". | +| [`SetCapillaryFrictionCoefficient`](#generated.RAFeedConveyor.SetCapillaryFrictionCoefficient)(value) | Set the value of "Capillary Friction Coefficient". | | [`SetCurrentTimeStep`](#generated.RAFeedConveyor.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetDecelerationPeriod`](#generated.RAFeedConveyor.SetDecelerationPeriod)(value[, unit]) | Set the value of "Deceleration Period". | | [`SetDiameter`](#generated.RAFeedConveyor.SetDiameter)(value[, unit]) | Set the value of "Diameter". | @@ -202,7 +208,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -214,7 +220,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -281,30 +287,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -506,16 +510,14 @@ Get the value of “Acceleration Period”. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -616,83 +618,79 @@ Get the value of “Belt Width”. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. + + +#### GetCapillaryFrictionCoefficient() + +Get the value of “Capillary Friction Coefficient”. + -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -701,39 +699,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -767,22 +761,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -869,6 +861,35 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFaceWidth(unit: str | None = None) @@ -893,19 +914,30 @@ Get the value of “Front Plate Offset”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -927,13 +959,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -941,22 +971,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -1005,7 +1022,7 @@ Get the “Material”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -1046,31 +1063,27 @@ Get the value of a module property. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1179,8 +1192,6 @@ Get “Thermal Boundary Condition Type” as a string. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1218,16 +1229,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1298,6 +1307,21 @@ Get the value of “Vertical Offset”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetWallThickness(unit: str | None = None) @@ -1318,44 +1342,40 @@ Get the value of “Width”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1365,12 +1385,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1510,6 +1530,15 @@ Set the value of “Belt Width”. * **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”. + + +#### SetCapillaryFrictionCoefficient(value: str | float) + +Set the value of “Capillary Friction Coefficient”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + #### SetCurrentTimeStep(time_step) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFilterProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFilterProcess.md index 294cb77b9c..c863ce337c 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFilterProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFilterProcess.md @@ -22,70 +22,74 @@ is still used internally. **Methods:** -| Name | Description | -|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCurve`](#generated.RAFilterProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -| [`AddCustomCurve`](#generated.RAFilterProcess.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`AddCustomProperty`](#generated.RAFilterProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAFilterProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAFilterProcess.CreateCurveOutputVariable)(curve_name[, ...]) | Used to create an output variable based on a curve which doesn't change at each new timestep (i.e.: a curve with a single value for each time). | -| [`CreateGridFunction`](#generated.RAFilterProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAFilterProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFilterProcess.CreateGridFunctionStatisticOutputVariable)(...) | Used to create an output variable based on a grid function statistic (i.e.: will get a grid function, compute its statistic based on statistic_operation and then based on the statistic values will apply the operation to get a single scalar). | -| [`CreateTransientCurveOutputVariable`](#generated.RAFilterProcess.CreateTransientCurveOutputVariable)(curve_name) | Used to create an output variable based on a curve for which there's a completely new representation for each time step -- such as Power : Impact X Belt Width (i.e.: will get the curve multiple times based on the time range, compute a value for each time based on the operation, to convert the multiple curves into a single curve and then will apply the time_operation to get a single scalar from those values). | -| [`EditCustomCurve`](#generated.RAFilterProcess.EditCustomCurve)(edit_curve[, new_name, ...]) | Edit a custom curve saved in the database. :param edit_curve: The name of the curve to be edited. :param new_name: The new name of the curve to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`EditCustomProperty`](#generated.RAFilterProcess.EditCustomProperty)(edit_property[, ...]) | Edit a custom property saved in the database. :param edit_property: The name of the property to be edited. :param new_name: The new name of the property to be set. :param sources: A dict pointing the variable used to the property association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`GetActivesArray`](#generated.RAFilterProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAFilterProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAFilterProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAFilterProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAFilterProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAFilterProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAFilterProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAFilterProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAFilterProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAFilterProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAFilterProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAFilterProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAFilterProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetCutValue`](#generated.RAFilterProcess.GetCutValue)([unit]) | | -| [`GetElementCurve`](#generated.RAFilterProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetGeometryQuantity`](#generated.RAFilterProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`GetGeometryUnit`](#generated.RAFilterProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | -| [`GetGridFunction`](#generated.RAFilterProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAFilterProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | -| [`GetMaxValue`](#generated.RAFilterProcess.GetMaxValue)([unit]) | | -| [`GetMeshColoring`](#generated.RAFilterProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMinValue`](#generated.RAFilterProcess.GetMinValue)([unit]) | | -| [`GetMode`](#generated.RAFilterProcess.GetMode)() | | -| [`GetNumberOfCells`](#generated.RAFilterProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAFilterProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RAFilterProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAFilterProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RAFilterProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetPropertyGridFunction`](#generated.RAFilterProcess.GetPropertyGridFunction)() | Get the grid function which this property process will use to filter its input elements | -| [`GetTimeSet`](#generated.RAFilterProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAFilterProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAFilterProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAFilterProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetType`](#generated.RAFilterProcess.GetType)() | | -| [`HasGridFunction`](#generated.RAFilterProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | -| [`IsCellActive`](#generated.RAFilterProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IterCellVertices`](#generated.RAFilterProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAFilterProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAFilterProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAFilterProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAFilterProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAFilterProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAFilterProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAFilterProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAFilterProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetCutValue`](#generated.RAFilterProcess.SetCutValue)(value[, unit]) | Sets the single, exact value by which you want the property results limited when Type is Value | -| [`SetMaxValue`](#generated.RAFilterProcess.SetMaxValue)(value[, unit]) | Sets the highest value by which you want the property results limited when Type is Range | -| [`SetMinValue`](#generated.RAFilterProcess.SetMinValue)(value[, unit]) | Sets the lowest value by which you want the property results limited when Type is Range | -| [`SetMode`](#generated.RAFilterProcess.SetMode)(property_mode) | | -| [`SetPropertyGridFunction`](#generated.RAFilterProcess.SetPropertyGridFunction)(grid_function[, ...]) | Set the grid function which this property process will use to filter its input elements | -| [`SetType`](#generated.RAFilterProcess.SetType)(filter_type) | | +| Name | +| -------------------------------------------------------------------------------------------------------------------------- | +| [`AddCurve`](#generated.RAFilterProcess.AddCurve)(curve_name, timesteps, values, unit) | +| [`AddCustomCurve`](#generated.RAFilterProcess.AddCustomCurve)(name[, curve_type, ...]) | +| [`AddCustomProperty`](#generated.RAFilterProcess.AddCustomProperty)(name[, property_type, ...]) | +| [`AddGridFunction`](#generated.RAFilterProcess.AddGridFunction)(grid_function_name, ...[, ...]) | +| [`CreateCurveOutputVariable`](#generated.RAFilterProcess.CreateCurveOutputVariable)(curve_name[, ...]) | +| [`CreateGridFunction`](#generated.RAFilterProcess.CreateGridFunction)(values[, location, time_step]) | +| [`CreateGridFunctionArrayOnCells`](#generated.RAFilterProcess.CreateGridFunctionArrayOnCells)([time_step]) | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAFilterProcess.CreateGridFunctionStatisticOutputVariable)(...) | +| [`CreateTransientCurveOutputVariable`](#generated.RAFilterProcess.CreateTransientCurveOutputVariable)(curve_name) | +| [`EditCustomCurve`](#generated.RAFilterProcess.EditCustomCurve)(edit_curve[, new_name, ...]) | +| [`EditCustomProperty`](#generated.RAFilterProcess.EditCustomProperty)(edit_property[, ...]) | +| [`GetActivesArray`](#generated.RAFilterProcess.GetActivesArray)([time_step]) | +| [`GetBoundingBox`](#generated.RAFilterProcess.GetBoundingBox)([unit, time_step]) | +| [`GetCellAreaAsArray`](#generated.RAFilterProcess.GetCellAreaAsArray)([time_step]) | +| [`GetCellCenterAsArray`](#generated.RAFilterProcess.GetCellCenterAsArray)([time_step]) | +| [`GetCellDzAsArray`](#generated.RAFilterProcess.GetCellDzAsArray)([time_step]) | +| [`GetCellFromIJK`](#generated.RAFilterProcess.GetCellFromIJK)(i, j, k[, time_step]) | +| [`GetCellIJK`](#generated.RAFilterProcess.GetCellIJK)(cell_handle[, time_step]) | +| [`GetCellNumberOfVertices`](#generated.RAFilterProcess.GetCellNumberOfVertices)(cell[, time_step]) | +| [`GetCellPointsAsFunction`](#generated.RAFilterProcess.GetCellPointsAsFunction)([time_step]) | +| [`GetCellVolumeAsArray`](#generated.RAFilterProcess.GetCellVolumeAsArray)([time_step]) | +| [`GetCurve`](#generated.RAFilterProcess.GetCurve)(curve_name[, simulation_name, ...]) | +| [`GetCurveNames`](#generated.RAFilterProcess.GetCurveNames)([simulation_name]) | +| [`GetCurveNamesAssociation`](#generated.RAFilterProcess.GetCurveNamesAssociation)([simulation_name]) | +| [`GetCutValue`](#generated.RAFilterProcess.GetCutValue)([unit]) | +| [`GetElementCurve`](#generated.RAFilterProcess.GetElementCurve)(element_name, curve_name[, ...]) | +| [`GetFacePositions`](#generated.RAFilterProcess.GetFacePositions)([time_step]) | +| [`GetFaceVertices`](#generated.RAFilterProcess.GetFaceVertices)([time_step]) | +| [`GetGeometryQuantity`](#generated.RAFilterProcess.GetGeometryQuantity)() | +| [`GetGeometryTransform`](#generated.RAFilterProcess.GetGeometryTransform)([time_step]) | +| [`GetGeometryUnit`](#generated.RAFilterProcess.GetGeometryUnit)() | +| [`GetGridFunction`](#generated.RAFilterProcess.GetGridFunction)(grid_function_name[, ...]) | +| [`GetGridFunctionNames`](#generated.RAFilterProcess.GetGridFunctionNames)([translated, context]) | +| [`GetMaxValue`](#generated.RAFilterProcess.GetMaxValue)([unit]) | +| [`GetMeshColoring`](#generated.RAFilterProcess.GetMeshColoring)(window) | +| [`GetMinValue`](#generated.RAFilterProcess.GetMinValue)([unit]) | +| [`GetMode`](#generated.RAFilterProcess.GetMode)() | +| [`GetNumberOfCells`](#generated.RAFilterProcess.GetNumberOfCells)([time_step]) | +| [`GetNumberOfNodes`](#generated.RAFilterProcess.GetNumberOfNodes)([time_step]) | +| [`GetNumberOfParticles`](#generated.RAFilterProcess.GetNumberOfParticles)(time_step) | +| [`GetNumpyCurve`](#generated.RAFilterProcess.GetNumpyCurve)(curve_name[, unit, realization]) | +| [`GetOutputVariableValue`](#generated.RAFilterProcess.GetOutputVariableValue)(variable_name) | +| [`GetPropertyGridFunction`](#generated.RAFilterProcess.GetPropertyGridFunction)() | +| [`GetTimeSet`](#generated.RAFilterProcess.GetTimeSet)() | +| [`GetTimeStatistics`](#generated.RAFilterProcess.GetTimeStatistics)() | +| [`GetTimeStep`](#generated.RAFilterProcess.GetTimeStep)(time_step[, accept_global]) | +| [`GetTopologyShape`](#generated.RAFilterProcess.GetTopologyShape)([time_step]) | +| [`GetType`](#generated.RAFilterProcess.GetType)() | +| [`GetVertices`](#generated.RAFilterProcess.GetVertices)([time_step]) | +| [`HasGridFunction`](#generated.RAFilterProcess.HasGridFunction)(grid_function_name) | +| [`IsCellActive`](#generated.RAFilterProcess.IsCellActive)(i, j, k[, time_step]) | +| [`IterCellVertices`](#generated.RAFilterProcess.IterCellVertices)(cell[, time_step]) | +| [`IterCells`](#generated.RAFilterProcess.IterCells)([time_step]) | +| [`IterParticles`](#generated.RAFilterProcess.IterParticles)(time_step) | +| [`Modified`](#generated.RAFilterProcess.Modified)(\*args, \*\*kwargs) | +| [`RemoveCustomCurve`](#generated.RAFilterProcess.RemoveCustomCurve)(name) | +| [`RemoveCustomProperty`](#generated.RAFilterProcess.RemoveCustomProperty)(name) | +| [`RemoveOutputVariable`](#generated.RAFilterProcess.RemoveOutputVariable)(variable_name) | +| [`RemoveProcess`](#generated.RAFilterProcess.RemoveProcess)() | +| [`SetCurrentTimeStep`](#generated.RAFilterProcess.SetCurrentTimeStep)(time_step) | +| [`SetCutValue`](#generated.RAFilterProcess.SetCutValue)(value[, unit]) | +| [`SetMaxValue`](#generated.RAFilterProcess.SetMaxValue)(value[, unit]) | +| [`SetMinValue`](#generated.RAFilterProcess.SetMinValue)(value[, unit]) | +| [`SetMode`](#generated.RAFilterProcess.SetMode)(property_mode) | +| [`SetPropertyGridFunction`](#generated.RAFilterProcess.SetPropertyGridFunction)(grid_function[, ...]) | +| [`SetType`](#generated.RAFilterProcess.SetType)(filter_type) | @@ -144,7 +148,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -156,7 +160,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -223,30 +227,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -439,99 +441,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -540,39 +530,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -606,22 +592,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -672,25 +656,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -712,13 +736,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -726,22 +748,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -754,7 +763,7 @@ Get a list of the available grid functions for this grid. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -785,31 +794,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -863,8 +868,6 @@ Get the grid function which this property process will use to filter its input e Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -902,16 +905,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -924,46 +925,57 @@ Get the shape of the topology (similar to the shape of numpy arrays). * **Returns:** Return whether the property process filters elements that match a specific value or a range of values + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -973,12 +985,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentOneWayCoupling.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentOneWayCoupling.md index 3634e0105a..5d6b1c69b8 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentOneWayCoupling.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentOneWayCoupling.md @@ -55,10 +55,13 @@ one_way_process = cfd_coupling.GetCouplingProcess() | [`GetCurveNamesAssociation`](#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetDragLaw`](#generated.RAFluentOneWayCoupling.GetDragLaw)() | Get the current "Drag Law". | | [`GetElementCurve`](#generated.RAFluentOneWayCoupling.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAFluentOneWayCoupling.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAFluentOneWayCoupling.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAFluentOneWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAFluentOneWayCoupling.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAFluentOneWayCoupling.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAFluentOneWayCoupling.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAFluentOneWayCoupling.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAFluentOneWayCoupling.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetIsOneWayPeriodic`](#generated.RAFluentOneWayCoupling.GetIsOneWayPeriodic)() | Get the value of "Is One Way Periodic". | | [`GetLiftLaw`](#generated.RAFluentOneWayCoupling.GetLiftLaw)() | Get the current "Lift Law". | | [`GetMeshColoring`](#generated.RAFluentOneWayCoupling.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | @@ -81,6 +84,7 @@ one_way_process = cfd_coupling.GetCouplingProcess() | [`GetUseTurbulentDispersion`](#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion)() | Get the value of "Use Turbulent Dispersion". | | [`GetUseUserDefinedConstants`](#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants)() | Get the current "Use User Defined Constants". | | [`GetUserCfdUpdateDistance`](#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance)([unit]) | Get the value of "User Cfd Update Distance". | +| [`GetVertices`](#generated.RAFluentOneWayCoupling.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetVirtualMassLaw`](#generated.RAFluentOneWayCoupling.GetVirtualMassLaw)() | Get the current "Virtual Mass Law". | | [`HasGridFunction`](#generated.RAFluentOneWayCoupling.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAFluentOneWayCoupling.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -168,7 +172,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -180,7 +184,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -254,30 +258,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -470,16 +472,14 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -492,20 +492,18 @@ Obtain the names of the boundaries available for coupling in the fluent file. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. @@ -519,65 +517,57 @@ Get the list of per-Particle CFD parameter sets. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -586,39 +576,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -652,16 +638,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -680,7 +664,7 @@ See also [`RACFDPerParticleParameters.GetConvectiveHeatTransferLaw()`](RACFDPerP -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -735,25 +719,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -775,13 +799,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -789,22 +811,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -827,7 +836,7 @@ See also [`RACFDPerParticleParameters.GetLiftLaw()`](RACFDPerParticleParameters. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -879,31 +888,27 @@ See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticl -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -972,8 +977,6 @@ See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticlePar Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1011,16 +1014,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1065,6 +1066,21 @@ 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”. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetVirtualMassLaw() @@ -1080,44 +1096,40 @@ See also [`RACFDPerParticleParameters.GetVirtualMassLaw()`](RACFDPerParticlePara -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1127,12 +1139,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentTwoWayCoupling.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentTwoWayCoupling.md index 1b8f36f746..f1d9d12b82 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentTwoWayCoupling.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluentTwoWayCoupling.md @@ -67,6 +67,8 @@ two_way_process = cfd_coupling.GetCouplingProcess() | [`GetDiffusionCoefficient`](#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient)([unit]) | Get the value of "Diffusion Coefficient". | | [`GetDragLaw`](#generated.RAFluentTwoWayCoupling.GetDragLaw)() | Get the current "Drag Law". | | [`GetElementCurve`](#generated.RAFluentTwoWayCoupling.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAFluentTwoWayCoupling.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAFluentTwoWayCoupling.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFluentAdditionalArgs`](#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs)() | Get the value of "Fluent Additional Args". | | [`GetFluentExecutionMode`](#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode)() | Get "Fluent Execution Mode" as a string. | | [`GetFluentOutputFrequencyMultiplier`](#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier)() | Get the value of "Fluent Output Frequency Multiplier". | @@ -75,16 +77,16 @@ two_way_process = cfd_coupling.GetCouplingProcess() | [`GetFluentVersion`](#generated.RAFluentTwoWayCoupling.GetFluentVersion)() | Get the value of "Version". | | [`GetFractionParticleSize`](#generated.RAFluentTwoWayCoupling.GetFractionParticleSize)([unit]) | Get the value of "Fraction Particle Size". | | [`GetGeometryQuantity`](#generated.RAFluentTwoWayCoupling.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAFluentTwoWayCoupling.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAFluentTwoWayCoupling.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAFluentTwoWayCoupling.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAFluentTwoWayCoupling.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAFluentTwoWayCoupling.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetLiftLaw`](#generated.RAFluentTwoWayCoupling.GetLiftLaw)() | Get the current "Lift Law". | | [`GetMappingMethod`](#generated.RAFluentTwoWayCoupling.GetMappingMethod)() | Get "Mapping Method" as a string. | | [`GetMaximumIterations`](#generated.RAFluentTwoWayCoupling.GetMaximumIterations)() | Get the value of "Maximum Iterations". | | [`GetMaximumResidualTolerance`](#generated.RAFluentTwoWayCoupling.GetMaximumResidualTolerance)() | Get the value of "Maximum Residual Tolerance". | | [`GetMaximumTimeSteps`](#generated.RAFluentTwoWayCoupling.GetMaximumTimeSteps)() | Get the value of "Maximum Time Steps". | | [`GetMaximumVolumeFraction`](#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFraction)([unit]) | Get the value of "Maximum Volume Fraction". | -| [`GetMaximumVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFractionTarget)() | Deprecated: use GetSolidsMaximumVolumeFractionTarget instead | | [`GetMeshColoring`](#generated.RAFluentTwoWayCoupling.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMinimumIterations`](#generated.RAFluentTwoWayCoupling.GetMinimumIterations)() | Get the value of "Minimum Iterations". | | [`GetMinimumTimeSteps`](#generated.RAFluentTwoWayCoupling.GetMinimumTimeSteps)() | Get the value of "Minimum Time Steps". | @@ -115,6 +117,7 @@ two_way_process = cfd_coupling.GetCouplingProcess() | [`GetValidAveragingRadiusTypeValues`](#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues)() | Get a list of all possible values for "Averaging Radius Type". | | [`GetValidFluentExecutionModeValues`](#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues)() | Get a list of all possible values for "Fluent Execution Mode". | | [`GetValidMappingMethodValues`](#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues)() | Get a list of all possible values for "Mapping Method". | +| [`GetVertices`](#generated.RAFluentTwoWayCoupling.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetVirtualMassLaw`](#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw)() | Get the current "Virtual Mass Law". | | [`GetVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget)() | Deprecated: Use [`GetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTwoWayCoupling.GetSolidsMaximumVolumeFractionTarget) instead. | | [`HasGridFunction`](#generated.RAFluentTwoWayCoupling.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | @@ -151,7 +154,6 @@ two_way_process = cfd_coupling.GetCouplingProcess() | [`SetMaximumResidualTolerance`](#generated.RAFluentTwoWayCoupling.SetMaximumResidualTolerance)(value) | Set the value of "Maximum Residual Tolerance". | | [`SetMaximumTimeSteps`](#generated.RAFluentTwoWayCoupling.SetMaximumTimeSteps)(value) | Set the value of "Maximum Time Steps". | | [`SetMaximumVolumeFraction`](#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFraction)(value[, unit]) | Set the value of "Maximum Volume Fraction". | -| [`SetMaximumVolumeFractionTarget`](#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFractionTarget)(value) | Deprecated: use SetSolidsMaximumVolumeFractionTarget instead | | [`SetMinimumIterations`](#generated.RAFluentTwoWayCoupling.SetMinimumIterations)(value) | Set the value of "Minimum Iterations". | | [`SetMinimumTimeSteps`](#generated.RAFluentTwoWayCoupling.SetMinimumTimeSteps)(value) | Set the value of "Minimum Time Steps". | | [`SetMorsiAndAlexanderK1`](#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK1)(value) | Set the current "Morsi And Alexander K1". | @@ -233,7 +235,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -245,7 +247,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -325,30 +327,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -574,16 +574,14 @@ Get the value of “Absolute Value”. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -620,20 +618,18 @@ Get the value of “Back Diffusion”. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. @@ -647,65 +643,57 @@ Get the list of per-Particle CFD parameter sets. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -714,39 +702,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -780,16 +764,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -814,7 +796,7 @@ Get the value of “Coupling Files Kept”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -884,6 +866,35 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFluentAdditionalArgs() @@ -946,19 +957,30 @@ Get the value of “Fraction Particle Size”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -980,13 +1002,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -994,22 +1014,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -1060,15 +1067,9 @@ Get the value of “Maximum Volume Fraction”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “-“. - - -#### GetMaximumVolumeFractionTarget() - -Deprecated: use GetSolidsMaximumVolumeFractionTarget instead - -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -1132,31 +1133,27 @@ See also [`RACFDPerParticleParameters.GetMorsiAndAlexanderK3()`](RACFDPerParticl -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1240,8 +1237,6 @@ See also [`RACFDPerParticleParameters.GetSyamlalObrienD1()`](RACFDPerParticlePar Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1279,16 +1274,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1375,6 +1368,21 @@ Get a list of all possible values for “Mapping Method”. * **Returns:** The returned list is [‘UniformDistribution’, ‘VolumetricDiffusion’, ‘DiffusionSolution’]. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetVirtualMassLaw() @@ -1396,14 +1404,12 @@ Deprecated: Use [`GetSolidsMaximumVolumeFractionTarget()`](#generated.RAFluentTw -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -1415,19 +1421,17 @@ Check if the “Back Diffusion” is enabled. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1448,13 +1452,13 @@ Check if the “Substepping” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1464,12 +1468,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1736,12 +1740,6 @@ Set the value of “Maximum Volume Fraction”. * **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 “-“. - - -#### SetMaximumVolumeFractionTarget(value) - -Deprecated: use SetSolidsMaximumVolumeFractionTarget instead - #### SetMinimumIterations(value: str | int) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidInlet.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidInlet.md index b2f5d03063..e34b972c01 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidInlet.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidInlet.md @@ -29,23 +29,44 @@ directly, such as the input’s name and the particle entry point. | Name | Description | |------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| [`DisablePeriodic`](#generated.RAFluidInlet.DisablePeriodic)() | Set the value of "Periodic" to False. | +| [`EnablePeriodic`](#generated.RAFluidInlet.EnablePeriodic)() | Set the value of "Periodic" to True. | | [`GetAvailableEntryPoints`](#generated.RAFluidInlet.GetAvailableEntryPoints)() | Get all available Entry Points. | | [`GetBoundaryCondition`](#generated.RAFluidInlet.GetBoundaryCondition)() | Get "Boundary Condition" as a string. | | [`GetEntryPoint`](#generated.RAFluidInlet.GetEntryPoint)() | Get the "Entry Point". | +| [`GetInjectionDuration`](#generated.RAFluidInlet.GetInjectionDuration)([unit]) | Get the value of "Injection Duration". | | [`GetMassFlowRate`](#generated.RAFluidInlet.GetMassFlowRate)([unit]) | Get the value of "Mass Flow Rate". | +| [`GetPeriod`](#generated.RAFluidInlet.GetPeriod)([unit]) | Get the value of "Period". | +| [`GetPeriodic`](#generated.RAFluidInlet.GetPeriodic)() | Get the value of "Periodic". | | [`GetStartTime`](#generated.RAFluidInlet.GetStartTime)([unit]) | Get the value of "Start Time". | | [`GetStopTime`](#generated.RAFluidInlet.GetStopTime)([unit]) | Get the value of "Stop Time". | | [`GetTemperature`](#generated.RAFluidInlet.GetTemperature)([unit]) | Get the value of "Temperature". | | [`GetValidBoundaryConditionValues`](#generated.RAFluidInlet.GetValidBoundaryConditionValues)() | Get a list of all possible values for "Boundary Condition". | | [`GetVelocity`](#generated.RAFluidInlet.GetVelocity)([unit]) | Get the value of "Velocity". | +| [`IsPeriodicEnabled`](#generated.RAFluidInlet.IsPeriodicEnabled)() | Check if the "Periodic" is enabled. | | [`SetBoundaryCondition`](#generated.RAFluidInlet.SetBoundaryCondition)(value) | Set the value of "Boundary Condition". | | [`SetEntryPoint`](#generated.RAFluidInlet.SetEntryPoint)(value) | Set the "Entry Point". | +| [`SetInjectionDuration`](#generated.RAFluidInlet.SetInjectionDuration)(value[, unit]) | Set the value of "Injection Duration". | | [`SetMassFlowRate`](#generated.RAFluidInlet.SetMassFlowRate)(value[, unit]) | Set the value of "Mass Flow Rate". | +| [`SetPeriod`](#generated.RAFluidInlet.SetPeriod)(value[, unit]) | Set the value of "Period". | +| [`SetPeriodic`](#generated.RAFluidInlet.SetPeriodic)(value) | Set the value of "Periodic". | | [`SetStartTime`](#generated.RAFluidInlet.SetStartTime)(value[, unit]) | Set the value of "Start Time". | | [`SetStopTime`](#generated.RAFluidInlet.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | | [`SetTemperature`](#generated.RAFluidInlet.SetTemperature)(value[, unit]) | Set the value of "Temperature". | | [`SetVelocity`](#generated.RAFluidInlet.SetVelocity)(value[, unit]) | Set the value of "Velocity". | + + +#### DisablePeriodic() + +Set the value of “Periodic” to False. + + + +#### EnablePeriodic() + +Set the value of “Periodic” to True. + #### GetAvailableEntryPoints() @@ -74,6 +95,15 @@ Get the “Entry Point”. * **Return type:** [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface) + + +#### GetInjectionDuration(unit: str | None = None) + +Get the value of “Injection Duration”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + #### GetMassFlowRate(unit: str | None = None) @@ -83,6 +113,21 @@ Get the value of “Mass Flow Rate”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “t/h”. + + +#### GetPeriod(unit: str | None = None) + +Get the value of “Period”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. + + + +#### GetPeriodic() + +Get the value of “Periodic”. + #### GetStartTime(unit: str | None = None) @@ -128,6 +173,12 @@ Get the value of “Velocity”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. + + +#### IsPeriodicEnabled() + +Check if the “Periodic” is enabled. + #### SetBoundaryCondition(value: str) @@ -148,6 +199,16 @@ Set the “Entry Point”. :param unicode, [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface) value: : Either the API object wrapping the desired entity or its name. + + +#### SetInjectionDuration(value: str | float, unit: str | None = None) + +Set the value of “Injection Duration”. + +* **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”. + #### SetMassFlowRate(value: str | float, unit: str | None = None) @@ -158,6 +219,25 @@ Set the value of “Mass Flow Rate”. * **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 “t/h”. + + +#### SetPeriod(value: str | float, unit: str | None = None) + +Set the value of “Period”. + +* **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”. + + + +#### SetPeriodic(value: bool) + +Set the value of “Periodic”. + +* **Parameters:** + **value** – The value to set. + #### SetStartTime(value: str | float, unit: str | None = None) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidMaterial.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidMaterial.md index d4c5c40b21..a4b0dffbe9 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidMaterial.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAFluidMaterial.md @@ -29,14 +29,12 @@ material_3 = material_collection[2] | [`GetDensity`](#generated.RAFluidMaterial.GetDensity)([unit]) | Get the value of "Density". | | [`GetModuleProperties`](#generated.RAFluidMaterial.GetModuleProperties)() | Get the names of the module properties. | | [`GetModuleProperty`](#generated.RAFluidMaterial.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetSoundSpeed`](#generated.RAFluidMaterial.GetSoundSpeed)([unit]) | Deprecated: Use this method from RASPHSettings instead | | [`GetSpecificHeat`](#generated.RAFluidMaterial.GetSpecificHeat)([unit]) | Get the value of "Specific Heat". | | [`GetThermalConductivity`](#generated.RAFluidMaterial.GetThermalConductivity)([unit]) | Get the value of "Thermal Conductivity". | | [`GetValidOptionsForModuleProperty`](#generated.RAFluidMaterial.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | | [`GetViscosity`](#generated.RAFluidMaterial.GetViscosity)([unit]) | Get the value of "Viscosity". | | [`SetDensity`](#generated.RAFluidMaterial.SetDensity)(value[, unit]) | Set the value of "Density". | | [`SetModuleProperty`](#generated.RAFluidMaterial.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetSoundSpeed`](#generated.RAFluidMaterial.SetSoundSpeed)(value[, unit]) | Deprecated: Use this method from RASPHSettings instead | | [`SetSpecificHeat`](#generated.RAFluidMaterial.SetSpecificHeat)(value[, unit]) | Set the value of "Specific Heat". | | [`SetThermalConductivity`](#generated.RAFluidMaterial.SetThermalConductivity)(value[, unit]) | Set the value of "Thermal Conductivity". | | [`SetViscosity`](#generated.RAFluidMaterial.SetViscosity)(value[, unit]) | Set the value of "Viscosity". | @@ -78,12 +76,6 @@ Get the value of a module property. - For properties that are lists of other properties, the returned value is a : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList). - - -#### GetSoundSpeed(unit: str | None = None) - -Deprecated: Use this method from RASPHSettings instead - #### GetSpecificHeat(unit: str | None = None) @@ -145,12 +137,6 @@ Set the value of a module property. * **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, value is assumed to be the unit was set before. - - -#### SetSoundSpeed(value: str | float, unit: str | None = None) - -Deprecated: Use this method from RASPHSettings instead - #### SetSpecificHeat(value: str | float, unit: str | None = None) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAGeometryCollection.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAGeometryCollection.md index 347ff03d18..45972f232b 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAGeometryCollection.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAGeometryCollection.md @@ -37,27 +37,37 @@ To create the different kind of geometries (conveyors, inlets and custom geometr **Methods:** | Name | Description | -|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| -| [`GetBoundingBox`](#generated.RAGeometryCollection.GetBoundingBox)(time_step[, force_load]) | Get the bounding box containing all geometries in this collection, at the given time. | -| [`GetGeometry`](#generated.RAGeometryCollection.GetGeometry)(geometry_name) | Get a geometry from its name. | -| [`GetGeometryNames`](#generated.RAGeometryCollection.GetGeometryNames)() | Get the names of the geometries in this collection. | -| [`IterInletGeometries`](#generated.RAGeometryCollection.IterInletGeometries)() | Iterate over the inlet geometries. | -| [`IterInputGeometries`](#generated.RAGeometryCollection.IterInputGeometries)() | Deprecated: Use [`IterInletGeometries()`](#generated.RAGeometryCollection.IterInletGeometries) instead. | -| [`IterSurfaces`](#generated.RAGeometryCollection.IterSurfaces)() | Iterate over the surface geometries. | -| [`IterSystemCouplingWalls`](#generated.RAGeometryCollection.IterSystemCouplingWalls)() | Iterate over the System Coupling walls geometries. | -| [`IterWalls`](#generated.RAGeometryCollection.IterWalls)() | Iterate over the walls geometries. | -| [`RemoveGeometry`](#generated.RAGeometryCollection.RemoveGeometry)(geometry) | Remove the given geometry from the project. | +|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| [`Clear`](#generated.RAGeometryCollection.Clear)() | Remove all items from the list. | +| [`GetBoundingBox`](#generated.RAGeometryCollection.GetBoundingBox)(time_step[, force_load, ...]) | Get the bounding box containing all geometries in this collection, at the given time. | +| [`GetGeometry`](#generated.RAGeometryCollection.GetGeometry)(geometry_name) | Get a geometry from its name. | +| [`GetGeometryNames`](#generated.RAGeometryCollection.GetGeometryNames)() | Get the names of the geometries in this collection. | +| [`IterInletGeometries`](#generated.RAGeometryCollection.IterInletGeometries)() | Iterate over the inlet geometries. | +| [`IterSurfaces`](#generated.RAGeometryCollection.IterSurfaces)() | Iterate over the surface geometries. | +| [`IterSystemCouplingWalls`](#generated.RAGeometryCollection.IterSystemCouplingWalls)() | Iterate over the System Coupling walls geometries. | +| [`IterWalls`](#generated.RAGeometryCollection.IterWalls)() | Iterate over the walls geometries. | +| [`New`](#generated.RAGeometryCollection.New)() | Add a new item. | +| [`Remove`](#generated.RAGeometryCollection.Remove)(item) | Remove an item from the list. | +| [`RemoveGeometry`](#generated.RAGeometryCollection.RemoveGeometry)(geometry) | Remove the given geometry from the project. | + + + +#### Clear() + +Remove all items from the list. -#### GetBoundingBox(time_step: ITimeStep | None, force_load: bool = False) +#### GetBoundingBox(time_step: ITimeStep | None, force_load: bool = False, force_orthogonal: bool = True) Get the bounding box containing all geometries in this collection, at the given time. * **Parameters:** - * **time_step** (*ITimeStep*) - * **force_load** (*bool*) -* **Rtype (FixedArray, FixedArray):** + * **time_step** – The time step for which the bounding box should be computed. + * **force_load** – If True, the bounding box will be computed by loading the geometries from the project. + If False, the bounding box will only be returned if it was already computed. + * **force_orthogonal** – If True, the bounding box will be computed in an orthogonal coordinate system. + If False, the bounding box will be computed in the original coordinate system of the geometries. * **Returns:** The bounding box of all the geometries in the passed time step, or None if the box could not be computed. @@ -83,12 +93,6 @@ Get the names of the geometries in this collection. Iterate over the inlet geometries. - - -#### IterInputGeometries() - -Deprecated: Use [`IterInletGeometries()`](#generated.RAGeometryCollection.IterInletGeometries) instead. - #### IterSurfaces() @@ -107,6 +111,18 @@ Iterate over the System Coupling walls geometries. Iterate over the walls geometries. + + +#### New() + +Add a new item. Returns the newly created item. + + + +#### Remove(item: T) + +Remove an item from the list. + #### RemoveGeometry(geometry: RABaseGeometry | str | None) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAGridFunction.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAGridFunction.md new file mode 100644 index 0000000000..c82aa4121e --- /dev/null +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAGridFunction.md @@ -0,0 +1,547 @@ + + +# RAGridFunction + + + + + + +### *class* RAGridFunction + +Identifies a grid function in the model. + +It acts as a handle of the grid function and not the actual grid function, which means that when +the time changes, this handle will start returning the values for the grid function at the new +time and not at the time where it was requested initially. + +I.e.: +: GoToFirstTimeStep() + grid = GetGrid(‘Main Grid’) + gf = grid.GetGridFunction(‘Oil Pressure’) + gf.GetMax() #Max value at time 0. + GoToNextTimeStep() + gf.GetMax() #Max value at time 1. + +Although most function also accept passing in the time. + +I.e.: +: grid = GetGrid(‘Main Grid’) + gf = grid.GetGridFunction(‘Oil Pressure’) + gf.GetMax(time_step=0) #Max value at time 0. + gf.GetMax(time_step=2) #Max value at time 2. + +**Methods:** + +| Name | Description | +|---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------| +| [`GetArray`](#generated.RAGridFunction.GetArray)([unit, time_step]) | | +| [`GetAverage`](#generated.RAGridFunction.GetAverage)([unit, time_step]) | | +| [`GetGrid`](#generated.RAGridFunction.GetGrid)() | | +| [`GetIsStatic`](#generated.RAGridFunction.GetIsStatic)() | | +| [`GetIsTransient`](#generated.RAGridFunction.GetIsTransient)() | | +| [`GetLimits`](#generated.RAGridFunction.GetLimits)([unit, time_step]) | | +| [`GetLocation`](#generated.RAGridFunction.GetLocation)() | | +| [`GetMax`](#generated.RAGridFunction.GetMax)([unit, time_step]) | | +| [`GetMin`](#generated.RAGridFunction.GetMin)([unit, time_step]) | | +| [`GetStandardDeviation`](#generated.RAGridFunction.GetStandardDeviation)([unit, time_step]) | | +| [`GetSum`](#generated.RAGridFunction.GetSum)([unit, time_step]) | | +| [`GetSumSquared`](#generated.RAGridFunction.GetSumSquared)([unit, time_step]) | | +| [`GetTimeStep`](#generated.RAGridFunction.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetUnit`](#generated.RAGridFunction.GetUnit)() | | +| [`GetValue`](#generated.RAGridFunction.GetValue)(i[, j, k, unit, time_step]) | | +| [`GetVariance`](#generated.RAGridFunction.GetVariance)([unit, time_step]) | | +| [`Modified`](#generated.RAGridFunction.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`SetCurrentTimeStep`](#generated.RAGridFunction.SetCurrentTimeStep)(time_step) | Sets the current time step. | + +**Attributes:** + +| Name | +| ---------------------------------------------------------------------- | +| [`average`](#generated.RAGridFunction.average) | +| [`is_static`](#generated.RAGridFunction.is_static) | +| [`is_transient`](#generated.RAGridFunction.is_transient) | +| [`limits`](#generated.RAGridFunction.limits) | +| [`max`](#generated.RAGridFunction.max) | +| [`min`](#generated.RAGridFunction.min) | +| [`standard_deviation`](#generated.RAGridFunction.standard_deviation) | +| [`sum`](#generated.RAGridFunction.sum) | +| [`sum_squared`](#generated.RAGridFunction.sum_squared) | +| [`unit`](#generated.RAGridFunction.unit) | +| [`variance`](#generated.RAGridFunction.variance) | + + + +#### GetArray(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the array should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + numpy array or None +* **Returns:** + Returns a numpy array representing the passed grid function or None if it couldn’t be + found. + + + +#### GetAverage(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the average value for the grid function or None if it’s not available for the + current time. + + + +#### GetGrid() + +* **Return type:** + KAGrid +* **Returns:** + The grid that “owns” the grid function. + + + +#### GetIsStatic() + +* **Return type:** + bool +* **Returns:** + Returns whether this grid function is static. + + + +#### GetIsTransient() + +* **Return type:** + bool +* **Returns:** + Returns whether this grid function is transient. + + + +#### GetLimits(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the limits should be gotten + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + list(float, float) or None +* **Returns:** + Returns a tuple with the min and max value for the limits and None if the limit is + not available for the current time. + + + +#### GetLocation() + +* **Return type:** + [‘cell’, ‘node’] +* **Returns:** + Returns whether this grid function is a cell or node/vertex grid function. + + + +#### GetMax(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the max value or None if it’s not available for the current time. + + + +#### GetMin(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the min value or None if it’s not available for the current time. + + + +#### GetStandardDeviation(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the standard deviation of the grid function or None if it’s not available for + the current time. + + + +#### GetSum(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the sum of all values in the grid function or None if it’s not available for + the current time. + + + +#### GetSumSquared(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the sum squared considering all values in the grid function or None if it’s + not available for the current time. + + + +#### GetTimeStep(time_step, accept_global=False) + +Get the timestep corresponding to the given time. + +* **Parameters:** + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + (note that if accept_global=False and ‘global’ is passed, an error is raised). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set + * **accept_global** (*bool*) – If True, a global time step is accepted (and returns None), otherwise, an error is + raised if ‘global’ is passed. +* **Return type:** + ITimeStep +* **Returns:** + Returns the time step to be used or None if accept_global == True and the time + step passed is ‘global’. + + + +#### GetUnit() + +* **Return type:** + str +* **Returns:** + Returns the default unit for the grid function. + + + +#### GetValue(i, j=None, k=None, unit=None, time_step='current') + +* **Parameters:** + * **i** (*int*) – The topological I cell index or the grid cell handle + * **j** (*int*) – The topological J cell index + * **k** (*int*) – The topological K cell index + * **unit** (*str*) – The unit in which the array should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float +* **Returns:** + Returns the grid function value for the given cell + + + +#### GetVariance(unit=None, time_step='current') + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the variance of the grid function or None if it’s not available for the + current time. + + + +#### Modified(\*args, \*\*kwargs) + +Resets all the cache information after a change in the subject being tracked. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### *property* average + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the average value for the grid function or None if it’s not available for the + current time. + + + +#### *property* is_static + +* **Return type:** + bool +* **Returns:** + Returns whether this grid function is static. + + + +#### *property* is_transient + +* **Return type:** + bool +* **Returns:** + Returns whether this grid function is transient. + + + +#### *property* limits + +* **Parameters:** + * **unit** (*str*) – The unit in which the limits should be gotten + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + list(float, float) or None +* **Returns:** + Returns a tuple with the min and max value for the limits and None if the limit is + not available for the current time. + + + +#### *property* max + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the max value or None if it’s not available for the current time. + + + +#### *property* min + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the min value or None if it’s not available for the current time. + + + +#### *property* standard_deviation + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the standard deviation of the grid function or None if it’s not available for + the current time. + + + +#### *property* sum + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the sum of all values in the grid function or None if it’s not available for + the current time. + + + +#### *property* sum_squared + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the sum squared considering all values in the grid function or None if it’s + not available for the current time. + + + +#### *property* unit + +* **Return type:** + str +* **Returns:** + Returns the default unit for the grid function. + + + +#### *property* variance + +* **Parameters:** + * **unit** (*str*) – The unit in which the value should be gotten (if not passed, the default unit is used). + * **time_step** (*str* *,* *ITimeStep* *or* *int*) – + + Either a string with ‘current’ identifying the current time step (note + that ‘global’ is NOT accepted for this statistic). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set +* **Return type:** + float or None +* **Returns:** + Returns a the variance of the grid function or None if it’s not available for the + current time. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletGeometry.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletGeometry.md index db01af41b7..ebb4bef009 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletGeometry.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletGeometry.md @@ -45,11 +45,14 @@ Rocky API Inlet model. | [`GetCurveNames`](#generated.RAInletGeometry.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAInletGeometry.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAInletGeometry.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAInletGeometry.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAInletGeometry.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAInletGeometry.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAInletGeometry.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryType`](#generated.RAInletGeometry.GetGeometryType)() | Get the Inlet geometry type, which is either 'rectangular' or 'circular'. | | [`GetGeometryUnit`](#generated.RAInletGeometry.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAInletGeometry.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAInletGeometry.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAInletGeometry.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetInclineAngle`](#generated.RAInletGeometry.GetInclineAngle)([unit]) | Get the value of "Incline Angle". | | [`GetLength`](#generated.RAInletGeometry.GetLength)([unit]) | Get the value of "Length". | | [`GetMeshColoring`](#generated.RAInletGeometry.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | @@ -62,6 +65,7 @@ Rocky API Inlet model. | [`GetTimeStatistics`](#generated.RAInletGeometry.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAInletGeometry.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAInletGeometry.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAInletGeometry.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetWidth`](#generated.RAInletGeometry.GetWidth)([unit]) | Get the value of "Width". | | [`HasGridFunction`](#generated.RAInletGeometry.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAInletGeometry.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -139,7 +143,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -151,7 +155,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -218,30 +222,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -434,16 +436,14 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -459,83 +459,73 @@ Get the value of “Alignment Angle”. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -544,39 +534,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -610,16 +596,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -645,7 +629,7 @@ Get the minimum and maximum radiuses for circular inlets. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -687,17 +671,59 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryType() @@ -710,8 +736,6 @@ Get the Inlet geometry type, which is either ‘rectangular’ or ‘circular’ Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -733,13 +757,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -747,22 +769,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -784,7 +793,7 @@ Get the value of “Length”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -797,31 +806,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -860,8 +865,6 @@ Get the rectangular length and width of the inlet. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -899,19 +902,32 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetWidth(unit: str | None = None) @@ -923,44 +939,40 @@ Get the value of “Width”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -970,12 +982,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletsOutletsCollection.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletsOutletsCollection.md index 4d62b97360..e9b8b3fc4e 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletsOutletsCollection.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAInletsOutletsCollection.md @@ -17,7 +17,7 @@ This wrapper corresponds to the “Inputs” item in the project’s data tree. [`RAInletsOutletsCollection`](#generated.RAInletsOutletsCollection) from a [`RAStudy`](RAStudy.md#generated.RAStudy), use: ```python -input_collection = study.GetParticleInputCollection() +input_collection = study.GetInletsOutletsCollection() ``` Instances of the [`RAInletsOutletsCollection`](#generated.RAInletsOutletsCollection) class act as regular Python lists, and can be @@ -36,24 +36,17 @@ Items in this list are of type [`RAParticleInlet`](RAParticleInlet.md#generated. **Methods:** | Name | Description | -|---------------------------------------------------------------------------------------------|---------------------------------------------| -| [`AddContinuousInjection`](#generated.RAInletsOutletsCollection.AddContinuousInjection)() | Add a new ContinuousInjection. | -| [`AddCustomInput`](#generated.RAInletsOutletsCollection.AddCustomInput)() | Add a new CustomInput. | -| [`AddFluidInlet`](#generated.RAInletsOutletsCollection.AddFluidInlet)() | Add a new SPHInlet. | -| [`AddOutlet`](#generated.RAInletsOutletsCollection.AddOutlet)() | Add a new Outlet. | -| [`AddParticleInlet`](#generated.RAInletsOutletsCollection.AddParticleInlet)() | Add a new ParticleInlet. | -| [`AddVolumetricInlet`](#generated.RAInletsOutletsCollection.AddVolumetricInlet)() | Add a new VolumeFill. | -| [`Clear`](#generated.RAInletsOutletsCollection.Clear)() | Remove all items from the list. | -| [`GetParticleInput`](#generated.RAInletsOutletsCollection.GetParticleInput)(input_name) | Get the particle input with the given name. | -| [`GetParticleInputNames`](#generated.RAInletsOutletsCollection.GetParticleInputNames)() | Get the names of all particle inputs. | -| [`New`](#generated.RAInletsOutletsCollection.New)() | Add a new item. | -| [`Remove`](#generated.RAInletsOutletsCollection.Remove)(item) | Remove an item from the list. | - - - -#### AddContinuousInjection() - -Add a new ContinuousInjection. Returns the newly created item. +|-----------------------------------------------------------------------------------------|---------------------------------------------| +| [`AddCustomInput`](#generated.RAInletsOutletsCollection.AddCustomInput)() | Add a new CustomInput. | +| [`AddFluidInlet`](#generated.RAInletsOutletsCollection.AddFluidInlet)() | Add a new SPHInlet. | +| [`AddOutlet`](#generated.RAInletsOutletsCollection.AddOutlet)() | Add a new Outlet. | +| [`AddParticleInlet`](#generated.RAInletsOutletsCollection.AddParticleInlet)() | Add a new ParticleInlet. | +| [`AddVolumetricInlet`](#generated.RAInletsOutletsCollection.AddVolumetricInlet)() | Add a new VolumeFill. | +| [`Clear`](#generated.RAInletsOutletsCollection.Clear)() | Remove all items from the list. | +| [`GetParticleInput`](#generated.RAInletsOutletsCollection.GetParticleInput)(input_name) | Get the particle input with the given name. | +| [`GetParticleInputNames`](#generated.RAInletsOutletsCollection.GetParticleInputNames)() | Get the names of all particle inputs. | +| [`New`](#generated.RAInletsOutletsCollection.New)() | Add a new item. | +| [`Remove`](#generated.RAInletsOutletsCollection.Remove)(item) | Remove an item from the list. | diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAInspectorProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAInspectorProcess.md index b972cc525a..34e7f51423 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAInspectorProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAInspectorProcess.md @@ -40,10 +40,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNames`](#generated.RAInspectorProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAInspectorProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAInspectorProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAInspectorProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAInspectorProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAInspectorProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAInspectorProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAInspectorProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAInspectorProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAInspectorProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAInspectorProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAInspectorProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAInspectorProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAInspectorProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -54,6 +57,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RAInspectorProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAInspectorProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAInspectorProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAInspectorProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAInspectorProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAInspectorProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAInspectorProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -123,7 +127,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -135,7 +139,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -202,30 +206,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -418,99 +420,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -519,39 +509,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -585,22 +571,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -642,25 +626,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -682,13 +706,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -696,26 +718,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -728,31 +737,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -795,8 +800,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -834,59 +837,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -896,12 +908,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAMaterialCollection.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAMaterialCollection.md index d0362fce13..7e353038d1 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAMaterialCollection.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAMaterialCollection.md @@ -35,18 +35,16 @@ Items in this list are of type [`RASolidMaterial`](RASolidMaterial.md#generated. **Methods:** | Name | Description | -|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| [`Clear`](#generated.RAMaterialCollection.Clear)() | Remove all items from the list. | -| [`GetBulkSolidFraction`](#generated.RAMaterialCollection.GetBulkSolidFraction)() | Get the value of "Bulk Solid Fraction". | -| [`GetDefaultMaterials`](#generated.RAMaterialCollection.GetDefaultMaterials)() | Deprecated: Use [`GetDefaultSolidMaterials()`](#generated.RAMaterialCollection.GetDefaultSolidMaterials) instead. | -| [`GetDefaultSolidMaterials`](#generated.RAMaterialCollection.GetDefaultSolidMaterials)() | Get a list with the default solid materials, in order of Particle, Belt and Boundary. | -| [`GetFluidMaterial`](#generated.RAMaterialCollection.GetFluidMaterial)(material_name) | Get the fluid material with the given name. | -| [`GetMaterial`](#generated.RAMaterialCollection.GetMaterial)(material_name) | Deprecated: Use [`GetSolidMaterial()`](#generated.RAMaterialCollection.GetSolidMaterial) instead. | -| [`GetMaterialsInteractionCollection`](#generated.RAMaterialCollection.GetMaterialsInteractionCollection)() | Get the study's Materials Interaction Collection. | -| [`GetSolidMaterial`](#generated.RAMaterialCollection.GetSolidMaterial)(material_name) | Get the solid material with the given name. | -| [`New`](#generated.RAMaterialCollection.New)() | Deprecated: Use `Add{Solid, Fluid}Material()` instead. | -| [`Remove`](#generated.RAMaterialCollection.Remove)(item) | Remove an item from the list. | -| [`SetBulkSolidFraction`](#generated.RAMaterialCollection.SetBulkSolidFraction)(value) | Set the value of "Bulk Solid Fraction". | +|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| [`Clear`](#generated.RAMaterialCollection.Clear)() | Remove all items from the list. | +| [`GetBulkSolidFraction`](#generated.RAMaterialCollection.GetBulkSolidFraction)() | Get the value of "Bulk Solid Fraction". | +| [`GetDefaultSolidMaterials`](#generated.RAMaterialCollection.GetDefaultSolidMaterials)() | Get a list with the default solid materials, in order of Particle, Belt and Boundary. | +| [`GetFluidMaterial`](#generated.RAMaterialCollection.GetFluidMaterial)(material_name) | Get the fluid material with the given name. | +| [`GetMaterialsInteractionCollection`](#generated.RAMaterialCollection.GetMaterialsInteractionCollection)() | Get the study's Materials Interaction Collection. | +| [`GetSolidMaterial`](#generated.RAMaterialCollection.GetSolidMaterial)(material_name) | Get the solid material with the given name. | +| [`New`](#generated.RAMaterialCollection.New)() | Deprecated: Use `Add{Solid, Fluid}Material()` instead. | +| [`Remove`](#generated.RAMaterialCollection.Remove)(item) | Remove an item from the list. | +| [`SetBulkSolidFraction`](#generated.RAMaterialCollection.SetBulkSolidFraction)(value) | Set the value of "Bulk Solid Fraction". | @@ -60,12 +58,6 @@ Remove all items from the list. Get the value of “Bulk Solid Fraction”. - - -#### GetDefaultMaterials() - -Deprecated: Use [`GetDefaultSolidMaterials()`](#generated.RAMaterialCollection.GetDefaultSolidMaterials) instead. - #### GetDefaultSolidMaterials() @@ -78,12 +70,6 @@ Get a list with the default solid materials, in order of Particle, Belt and Boun Get the fluid material with the given name. - - -#### GetMaterial(material_name: str) - -Deprecated: Use [`GetSolidMaterial()`](#generated.RAMaterialCollection.GetSolidMaterial) instead. - #### GetMaterialsInteractionCollection() @@ -104,7 +90,7 @@ Deprecated: Use `Add{Solid, Fluid}Material()` instead. -#### Remove(item: T) +#### Remove(item: ApiElementItem) Remove an item from the list. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAModuleOutput.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAModuleOutput.md index f1d0cee89e..deb49e8d5a 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAModuleOutput.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAModuleOutput.md @@ -42,10 +42,13 @@ Wrapper class for the object that represents a Module’s unique output. | [`GetCurveNames`](#generated.RAModuleOutput.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAModuleOutput.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAModuleOutput.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAModuleOutput.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAModuleOutput.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAModuleOutput.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAModuleOutput.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAModuleOutput.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAModuleOutput.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAModuleOutput.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAModuleOutput.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAModuleOutput.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAModuleOutput.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAModuleOutput.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -55,6 +58,7 @@ Wrapper class for the object that represents a Module’s unique output. | [`GetTimeStatistics`](#generated.RAModuleOutput.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAModuleOutput.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAModuleOutput.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAModuleOutput.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAModuleOutput.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAModuleOutput.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAModuleOutput.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -123,7 +127,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -135,7 +139,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -202,30 +206,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -418,99 +420,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -519,39 +509,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -585,22 +571,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -642,25 +626,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -682,13 +706,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -696,26 +718,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -728,31 +737,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -780,8 +785,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -819,59 +822,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -881,12 +893,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticle.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticle.md index c1a601d285..d400b5cd1a 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticle.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticle.md @@ -56,6 +56,7 @@ in this wrapper class. An exception is size-related methods, which must be confi | [`GetActivesArray`](#generated.RAParticle.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | | [`GetAllowSelfContacts`](#generated.RAParticle.GetAllowSelfContacts)() | Get the value of "Allow Self Contacts". | | [`GetAnisotropic`](#generated.RAParticle.GetAnisotropic)() | Deprecated: Use [`GetElasticity()`](#generated.RAParticle.GetElasticity) instead. | +| [`GetAssemblyCustom`](#generated.RAParticle.GetAssemblyCustom)() | Deprecated: Use `GetCustomProperties()` instead. | | [`GetAvailableMaterials`](#generated.RAParticle.GetAvailableMaterials)() | Get all available Materials. | | [`GetBendingAngleLimit`](#generated.RAParticle.GetBendingAngleLimit)([unit]) | Get the value of "Bending Angle Limit". | | [`GetBoundingBox`](#generated.RAParticle.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | @@ -87,12 +88,15 @@ in this wrapper class. An exception is size-related methods, which must be confi | [`GetEnableBreakage`](#generated.RAParticle.GetEnableBreakage)() | Get the value of "Enable Breakage". | | [`GetEnableRandomAngle`](#generated.RAParticle.GetEnableRandomAngle)() | Get the value of "Enable Random Angle". | | [`GetEnableRotations`](#generated.RAParticle.GetEnableRotations)() | Get the value of "Enable Rotations". | +| [`GetFacePositions`](#generated.RAParticle.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAParticle.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFailureRatio`](#generated.RAParticle.GetFailureRatio)() | Get the value of "Failure Ratio". | | [`GetFlexible`](#generated.RAParticle.GetFlexible)() | Get the value of "Flexible". | | [`GetGeometryQuantity`](#generated.RAParticle.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAParticle.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAParticle.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAParticle.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAParticle.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAParticle.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetHorizontalAspectRatio`](#generated.RAParticle.GetHorizontalAspectRatio)() | Get the value of "Horizontal Aspect Ratio". | | [`GetIncludeRotationalDeformations`](#generated.RAParticle.GetIncludeRotationalDeformations)() | Get the value of "Include Rotational Deformations". | | [`GetInternalFriction`](#generated.RAParticle.GetInternalFriction)() | Get the value of "Internal Friction". | @@ -124,8 +128,6 @@ in this wrapper class. An exception is size-related methods, which must be confi | [`GetRatioEnergyAfterBreakage`](#generated.RAParticle.GetRatioEnergyAfterBreakage)([unit]) | Get the value of "Ratio Energy After Breakage". | | [`GetRemeshToTarget`](#generated.RAParticle.GetRemeshToTarget)() | Get the value of "Remesh To Target". | | [`GetRollingResistance`](#generated.RAParticle.GetRollingResistance)() | Get the value of "Rolling Resistance". | -| [`GetRotationAngle`](#generated.RAParticle.GetRotationAngle)([unit]) | Get the value of "Rotation Angle". | -| [`GetRotationVector`](#generated.RAParticle.GetRotationVector)([unit]) | Get the value of "Rotation Vector". | | [`GetSecondBendingAngleLimit`](#generated.RAParticle.GetSecondBendingAngleLimit)([unit]) | Get the value of "Second Bending Angle Limit". | | [`GetShape`](#generated.RAParticle.GetShape)() | Get "Shape" as a string. | | [`GetShearStressLimit`](#generated.RAParticle.GetShearStressLimit)([unit]) | Get the value of "Shear Stress Limit". | @@ -164,6 +166,7 @@ in this wrapper class. An exception is size-related methods, which must be confi | [`GetValidSizeTypeValues`](#generated.RAParticle.GetValidSizeTypeValues)() | Get a list of all possible values for "Size Type". | | [`GetValidT10FormulaValues`](#generated.RAParticle.GetValidT10FormulaValues)() | Get a list of all possible values for "T10 Formula". | | [`GetVerticalAspectRatio`](#generated.RAParticle.GetVerticalAspectRatio)() | Get the value of "Vertical Aspect Ratio". | +| [`GetVertices`](#generated.RAParticle.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetVonMisesStressLimit`](#generated.RAParticle.GetVonMisesStressLimit)([unit]) | Get the value of "Von Mises Stress Limit". | | [`GetWithFailure`](#generated.RAParticle.GetWithFailure)() | Get the value of "With Failure". | | [`GetXDirection`](#generated.RAParticle.GetXDirection)([unit]) | Get the value of "X Direction". | @@ -171,7 +174,6 @@ in this wrapper class. An exception is size-related methods, which must be confi | [`GetZDirection`](#generated.RAParticle.GetZDirection)([unit]) | Get the value of "Z Direction". | | [`HasGridFunction`](#generated.RAParticle.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`ImportCustomFiber`](#generated.RAParticle.ImportCustomFiber)(filename) | Import a custom fiber shape from the given filename into this particle. | -| [`ImportFiberFromTXT`](#generated.RAParticle.ImportFiberFromTXT)(stl_filename) | Import a custom fiber shape from the given txt filename into this particle. | | [`ImportFromSTL`](#generated.RAParticle.ImportFromSTL)(stl_filename, as_concave[, ...]) | Import a custom shape from the given stl filename into this particle. | | [`IsBreakageEnabled`](#generated.RAParticle.IsBreakageEnabled)() | Check if the "Breakage" is enabled. | | [`IsCellActive`](#generated.RAParticle.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -237,8 +239,6 @@ in this wrapper class. An exception is size-related methods, which must be confi | [`SetRatioEnergyAfterBreakage`](#generated.RAParticle.SetRatioEnergyAfterBreakage)(value[, unit]) | Set the value of "Ratio Energy After Breakage". | | [`SetRemeshToTarget`](#generated.RAParticle.SetRemeshToTarget)(value) | Set the value of "Remesh To Target". | | [`SetRollingResistance`](#generated.RAParticle.SetRollingResistance)(value) | Set the value of "Rolling Resistance". | -| [`SetRotationAngle`](#generated.RAParticle.SetRotationAngle)(value[, unit]) | Set the value of "Rotation Angle". | -| [`SetRotationVector`](#generated.RAParticle.SetRotationVector)(values[, unit]) | Set the values of "Rotation Vector". | | [`SetSecondBendingAngleLimit`](#generated.RAParticle.SetSecondBendingAngleLimit)(value[, unit]) | Set the value of "Second Bending Angle Limit". | | [`SetShape`](#generated.RAParticle.SetShape)(value) | Set the value of "Shape". | | [`SetShearStressLimit`](#generated.RAParticle.SetShearStressLimit)(value[, unit]) | Set the value of "Shear Stress Limit". | @@ -326,7 +326,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -338,7 +338,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -405,30 +405,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -702,16 +700,14 @@ Get the value of “Abt10 Select Function Coefficient”. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -731,6 +727,12 @@ Deprecated: Use [`GetElasticity()`](#generated.RAParticle.GetElasticity) instead * **Return type:** bool + + +#### GetAssemblyCustom() + +Deprecated: Use `GetCustomProperties()` instead. + #### GetAvailableMaterials() @@ -752,20 +754,18 @@ Get the value of “Bending Angle Limit”. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. @@ -779,65 +779,57 @@ Get “Breakage Model” as a string. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -846,39 +838,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -912,16 +900,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -948,7 +934,7 @@ Get the value of “Change Mass Properties”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -1074,6 +1060,35 @@ Get the value of “Enable Random Angle”. Get the value of “Enable Rotations”. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFailureRatio() @@ -1092,19 +1107,30 @@ Get the value of “Flexible”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -1126,13 +1152,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -1140,22 +1164,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -1204,7 +1215,7 @@ Get the “Material”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -1266,16 +1277,14 @@ Get the value of a module property. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells @@ -1287,16 +1296,14 @@ Get the value of “Number of Corners”. -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1415,26 +1422,6 @@ Get the value of “Remesh To Target”. Get the value of “Rolling Resistance”. - - -#### GetRotationAngle(unit: str = 'rad') - -Get the value of “Rotation Angle”. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in - “rad”. - - - -#### GetRotationVector(unit: str = '-') - -Get the value of “Rotation Vector”. - -* **Parameters:** - **unit** – The unit for the returned values. If no unit is provided, the returned values will be in - “m”. - #### GetSecondBendingAngleLimit(unit: str | None = None) @@ -1624,8 +1611,6 @@ Get the value of “Thickness”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1663,16 +1648,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1780,6 +1763,21 @@ Get a list of all possible values for “T10 Formula”. Get the value of “Vertical Aspect Ratio”. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetVonMisesStressLimit(unit: str | None = None) @@ -1824,14 +1822,12 @@ Get the value of “Z Direction”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -1846,14 +1842,6 @@ Import a custom fiber shape from the given filename into this particle. * **Returns:** Whether it was possible to import the particle - - -#### ImportFiberFromTXT(stl_filename) - -Import a custom fiber shape from the given txt filename into this particle. - -Deprecated: Use [`ImportCustomFiber()`](#generated.RAParticle.ImportCustomFiber) instead. - #### ImportFromSTL(stl_filename: str, as_concave: bool, is_open: bool = False) @@ -1877,19 +1865,17 @@ Check if the “Breakage” is enabled. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1916,13 +1902,13 @@ Check if the “Random Orientation” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1932,12 +1918,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -2482,29 +2468,6 @@ Set the value of “Rolling Resistance”. * **Parameters:** **value** – The value to set. This value can be an expression with input variables or float type. - - -#### SetRotationAngle(value: str | float, unit: str = 'rad') - -Set the value of “Rotation Angle”. - -* **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 “rad”. - - - -#### SetRotationVector(values: Sequence[str | float], unit: str = '-') - -Set the values of “Rotation Vector”. - -* **Parameters:** - * **values** – The values to set. The values can be heterogeneous, the element of values can be an - expression with input variables or a float. Must have exactly 3 elements. - * **unit** – The unit for values. If no unit is provided, values is assumed to be in “m”. -* **Raises:** - **RockyApiError** – If values doesn’t have exactly 3 elements. - #### SetSecondBendingAngleLimit(value: str | float, unit: str | None = None) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInlet.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInlet.md index 728f98cd0c..9605f3b45b 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInlet.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInlet.md @@ -31,57 +31,59 @@ This list must be manipulated via the `RAParticleInputPropertiesList` returned b **Methods:** | Name | Description | -|-----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------| -| [`DisableForcePacking`](#generated.RAParticleInlet.DisableForcePacking)() | Set the value of "Force Packing" to False. | -| [`DisablePeriodic`](#generated.RAParticleInlet.DisablePeriodic)() | Set the value of "Periodic" to False. | -| [`DisablePeriodicDischarge`](#generated.RAParticleInlet.DisablePeriodicDischarge)() | Deprecated: Use [`DisablePeriodic()`](#generated.RAParticleInlet.DisablePeriodic) instead. | -| [`DisableStopAllAtStopTime`](#generated.RAParticleInlet.DisableStopAllAtStopTime)() | Set the value of "Stop All At Stop Time" to False. | -| [`DisableUseTargetNormalVelocity`](#generated.RAParticleInlet.DisableUseTargetNormalVelocity)() | Set the value of "Use Target Normal Velocity" to False. | -| [`EnableForcePacking`](#generated.RAParticleInlet.EnableForcePacking)() | Set the value of "Force Packing" to True. | -| [`EnablePeriodic`](#generated.RAParticleInlet.EnablePeriodic)() | Set the value of "Periodic" to True. | -| [`EnablePeriodicDischarge`](#generated.RAParticleInlet.EnablePeriodicDischarge)() | Deprecated: Use [`EnablePeriodic()`](#generated.RAParticleInlet.EnablePeriodic) instead. | -| [`EnableStopAllAtStopTime`](#generated.RAParticleInlet.EnableStopAllAtStopTime)() | Set the value of "Stop All At Stop Time" to True. | -| [`EnableUseTargetNormalVelocity`](#generated.RAParticleInlet.EnableUseTargetNormalVelocity)() | Set the value of "Use Target Normal Velocity" to True. | -| [`GetAvailableEntryPoints`](#generated.RAParticleInlet.GetAvailableEntryPoints)() | Get all available Entry Points. | -| [`GetDischargeTime`](#generated.RAParticleInlet.GetDischargeTime)([unit]) | Deprecated: Use [`GetInjectionDuration()`](#generated.RAParticleInlet.GetInjectionDuration) instead. | -| [`GetEntryPoint`](#generated.RAParticleInlet.GetEntryPoint)() | Get the "Entry Point". | -| [`GetForcePacking`](#generated.RAParticleInlet.GetForcePacking)() | Get the value of "Force Packing". | -| [`GetInjectionDuration`](#generated.RAParticleInlet.GetInjectionDuration)([unit]) | Get the value of "Injection Duration". | -| [`GetInputPropertiesList`](#generated.RAParticleInlet.GetInputPropertiesList)() | Return a list of input properties | -| [`GetPeriod`](#generated.RAParticleInlet.GetPeriod)([unit]) | Get the value of "Period". | -| [`GetPeriodic`](#generated.RAParticleInlet.GetPeriodic)() | Get the value of "Periodic". | -| [`GetPeriodicDischarge`](#generated.RAParticleInlet.GetPeriodicDischarge)() | Deprecated: Use [`GetPeriodic()`](#generated.RAParticleInlet.GetPeriodic) instead. | -| [`GetSphInjectionEnabled`](#generated.RAParticleInlet.GetSphInjectionEnabled)() | Get the value of "Sph Injection Enabled". | -| [`GetSphTemperature`](#generated.RAParticleInlet.GetSphTemperature)([unit]) | Get the value of "Sph Temperature". | -| [`GetStartTime`](#generated.RAParticleInlet.GetStartTime)([unit]) | Get the value of "Start Time". | -| [`GetStopAllAtStopTime`](#generated.RAParticleInlet.GetStopAllAtStopTime)() | Get the value of "Stop All At Stop Time". | -| [`GetStopTime`](#generated.RAParticleInlet.GetStopTime)([unit]) | Get the value of "Stop Time". | -| [`GetTargetNormalVelocity`](#generated.RAParticleInlet.GetTargetNormalVelocity)([unit]) | Get the value of "Target Normal Velocity". | -| [`GetTonnageList`](#generated.RAParticleInlet.GetTonnageList)() | Deprecated: Use [`GetInputPropertiesList()`](#generated.RAParticleInlet.GetInputPropertiesList) instead. | -| [`GetUseTargetNormalVelocity`](#generated.RAParticleInlet.GetUseTargetNormalVelocity)() | Get the value of "Use Target Normal Velocity". | -| [`GetUxLocal`](#generated.RAParticleInlet.GetUxLocal)([unit]) | Get the value of "Ux Local". | -| [`GetUzLocal`](#generated.RAParticleInlet.GetUzLocal)([unit]) | Get the value of "Uz Local". | -| [`IsForcePackingEnabled`](#generated.RAParticleInlet.IsForcePackingEnabled)() | Check if the "Force Packing" is enabled. | -| [`IsPeriodicDischargeEnabled`](#generated.RAParticleInlet.IsPeriodicDischargeEnabled)() | Deprecated: Use [`IsPeriodicEnabled()`](#generated.RAParticleInlet.IsPeriodicEnabled) instead. | -| [`IsPeriodicEnabled`](#generated.RAParticleInlet.IsPeriodicEnabled)() | Check if the "Periodic" is enabled. | -| [`IsStopAllAtStopTimeEnabled`](#generated.RAParticleInlet.IsStopAllAtStopTimeEnabled)() | Check if the "Stop All At Stop Time" is enabled. | -| [`IsUseTargetNormalVelocityEnabled`](#generated.RAParticleInlet.IsUseTargetNormalVelocityEnabled)() | Check if the "Use Target Normal Velocity" is enabled. | -| [`SetDischargeTime`](#generated.RAParticleInlet.SetDischargeTime)(value[, unit]) | Deprecated: Use [`SetInjectionDuration()`](#generated.RAParticleInlet.SetInjectionDuration) instead. | -| [`SetEntryPoint`](#generated.RAParticleInlet.SetEntryPoint)(value) | Set the "Entry Point". | -| [`SetForcePacking`](#generated.RAParticleInlet.SetForcePacking)(value) | Set the value of "Force Packing". | -| [`SetInjectionDuration`](#generated.RAParticleInlet.SetInjectionDuration)(value[, unit]) | Set the value of "Injection Duration". | -| [`SetPeriod`](#generated.RAParticleInlet.SetPeriod)(value[, unit]) | Set the value of "Period". | -| [`SetPeriodic`](#generated.RAParticleInlet.SetPeriodic)(value) | Set the value of "Periodic". | -| [`SetPeriodicDischarge`](#generated.RAParticleInlet.SetPeriodicDischarge)(value) | Deprecated: Use [`SetPeriodic()`](#generated.RAParticleInlet.SetPeriodic) instead. | -| [`SetSphInjectionEnabled`](#generated.RAParticleInlet.SetSphInjectionEnabled)(value) | Set the value of "Sph Injection Enabled". | -| [`SetSphTemperature`](#generated.RAParticleInlet.SetSphTemperature)(value[, unit]) | Set the value of "Sph Temperature". | -| [`SetStartTime`](#generated.RAParticleInlet.SetStartTime)(value[, unit]) | Set the value of "Start Time". | -| [`SetStopAllAtStopTime`](#generated.RAParticleInlet.SetStopAllAtStopTime)(value) | Set the value of "Stop All At Stop Time". | -| [`SetStopTime`](#generated.RAParticleInlet.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | -| [`SetTargetNormalVelocity`](#generated.RAParticleInlet.SetTargetNormalVelocity)(value[, unit]) | Set the value of "Target Normal Velocity". | -| [`SetUseTargetNormalVelocity`](#generated.RAParticleInlet.SetUseTargetNormalVelocity)(value) | Set the value of "Use Target Normal Velocity". | -| [`SetUxLocal`](#generated.RAParticleInlet.SetUxLocal)(value[, unit]) | Set the value of "Ux Local". | -| [`SetUzLocal`](#generated.RAParticleInlet.SetUzLocal)(value[, unit]) | Set the value of "Uz Local". | +|-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| [`AddParticle`](#generated.RAParticleInlet.AddParticle)(particle) | Add a new particle to the Particle Inlet input properties list. | +| [`DisableForcePacking`](#generated.RAParticleInlet.DisableForcePacking)() | Set the value of "Force Packing" to False. | +| [`DisablePeriodic`](#generated.RAParticleInlet.DisablePeriodic)() | Set the value of "Periodic" to False. | +| [`DisableStopAllAtStopTime`](#generated.RAParticleInlet.DisableStopAllAtStopTime)() | Set the value of "Stop All At Stop Time" to False. | +| [`DisableUseTargetNormalVelocity`](#generated.RAParticleInlet.DisableUseTargetNormalVelocity)() | Set the value of "Use Target Normal Velocity" to False. | +| [`EnableForcePacking`](#generated.RAParticleInlet.EnableForcePacking)() | Set the value of "Force Packing" to True. | +| [`EnablePeriodic`](#generated.RAParticleInlet.EnablePeriodic)() | Set the value of "Periodic" to True. | +| [`EnableStopAllAtStopTime`](#generated.RAParticleInlet.EnableStopAllAtStopTime)() | Set the value of "Stop All At Stop Time" to True. | +| [`EnableUseTargetNormalVelocity`](#generated.RAParticleInlet.EnableUseTargetNormalVelocity)() | Set the value of "Use Target Normal Velocity" to True. | +| [`GetAvailableEntryPoints`](#generated.RAParticleInlet.GetAvailableEntryPoints)() | Get all available Entry Points. | +| [`GetEntryPoint`](#generated.RAParticleInlet.GetEntryPoint)() | Get the "Entry Point". | +| [`GetForcePacking`](#generated.RAParticleInlet.GetForcePacking)() | Get the value of "Force Packing". | +| [`GetInjectionDuration`](#generated.RAParticleInlet.GetInjectionDuration)([unit]) | Get the value of "Injection Duration". | +| [`GetInputPropertiesList`](#generated.RAParticleInlet.GetInputPropertiesList)() | Return a list of input properties | +| [`GetPeriod`](#generated.RAParticleInlet.GetPeriod)([unit]) | Get the value of "Period". | +| [`GetPeriodic`](#generated.RAParticleInlet.GetPeriodic)() | Get the value of "Periodic". | +| [`GetSphInjectionEnabled`](#generated.RAParticleInlet.GetSphInjectionEnabled)() | Get the value of "Sph Injection Enabled". | +| [`GetSphTemperature`](#generated.RAParticleInlet.GetSphTemperature)([unit]) | Get the value of "Sph Temperature". | +| [`GetStartTime`](#generated.RAParticleInlet.GetStartTime)([unit]) | Get the value of "Start Time". | +| [`GetStopAllAtStopTime`](#generated.RAParticleInlet.GetStopAllAtStopTime)() | Get the value of "Stop All At Stop Time". | +| [`GetStopTime`](#generated.RAParticleInlet.GetStopTime)([unit]) | Get the value of "Stop Time". | +| [`GetTargetNormalVelocity`](#generated.RAParticleInlet.GetTargetNormalVelocity)([unit]) | Get the value of "Target Normal Velocity". | +| [`GetUseTargetNormalVelocity`](#generated.RAParticleInlet.GetUseTargetNormalVelocity)() | Get the value of "Use Target Normal Velocity". | +| [`GetUxLocal`](#generated.RAParticleInlet.GetUxLocal)([unit]) | Get the value of "Ux Local". | +| [`GetUzLocal`](#generated.RAParticleInlet.GetUzLocal)([unit]) | Get the value of "Uz Local". | +| [`IsForcePackingEnabled`](#generated.RAParticleInlet.IsForcePackingEnabled)() | Check if the "Force Packing" is enabled. | +| [`IsPeriodicEnabled`](#generated.RAParticleInlet.IsPeriodicEnabled)() | Check if the "Periodic" is enabled. | +| [`IsStopAllAtStopTimeEnabled`](#generated.RAParticleInlet.IsStopAllAtStopTimeEnabled)() | Check if the "Stop All At Stop Time" is enabled. | +| [`IsUseTargetNormalVelocityEnabled`](#generated.RAParticleInlet.IsUseTargetNormalVelocityEnabled)() | Check if the "Use Target Normal Velocity" is enabled. | +| [`RemoveParticle`](#generated.RAParticleInlet.RemoveParticle)(particle) | Remove a particle from the Particle Inlet input properties list. | +| [`SetEntryPoint`](#generated.RAParticleInlet.SetEntryPoint)(value) | Set the "Entry Point". | +| [`SetForcePacking`](#generated.RAParticleInlet.SetForcePacking)(value) | Set the value of "Force Packing". | +| [`SetInjectionDuration`](#generated.RAParticleInlet.SetInjectionDuration)(value[, unit]) | Set the value of "Injection Duration". | +| [`SetPeriod`](#generated.RAParticleInlet.SetPeriod)(value[, unit]) | Set the value of "Period". | +| [`SetPeriodic`](#generated.RAParticleInlet.SetPeriodic)(value) | Set the value of "Periodic". | +| [`SetSphInjectionEnabled`](#generated.RAParticleInlet.SetSphInjectionEnabled)(value) | Set the value of "Sph Injection Enabled". | +| [`SetSphTemperature`](#generated.RAParticleInlet.SetSphTemperature)(value[, unit]) | Set the value of "Sph Temperature". | +| [`SetStartTime`](#generated.RAParticleInlet.SetStartTime)(value[, unit]) | Set the value of "Start Time". | +| [`SetStopAllAtStopTime`](#generated.RAParticleInlet.SetStopAllAtStopTime)(value) | Set the value of "Stop All At Stop Time". | +| [`SetStopTime`](#generated.RAParticleInlet.SetStopTime)(value[, unit]) | Set the value of "Stop Time". | +| [`SetTargetNormalVelocity`](#generated.RAParticleInlet.SetTargetNormalVelocity)(value[, unit]) | Set the value of "Target Normal Velocity". | +| [`SetUseTargetNormalVelocity`](#generated.RAParticleInlet.SetUseTargetNormalVelocity)(value) | Set the value of "Use Target Normal Velocity". | +| [`SetUxLocal`](#generated.RAParticleInlet.SetUxLocal)(value[, unit]) | Set the value of "Ux Local". | +| [`SetUzLocal`](#generated.RAParticleInlet.SetUzLocal)(value[, unit]) | Set the value of "Uz Local". | + + + +#### AddParticle(particle: RAParticle | str) + +Add a new particle to the Particle Inlet input properties list. + +: return: A new [`RAParticleInletPropertiesList`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList) object that can be used to set @@ -95,12 +97,6 @@ Set the value of “Force Packing” to False. Set the value of “Periodic” to False. - - -#### DisablePeriodicDischarge() - -Deprecated: Use [`DisablePeriodic()`](#generated.RAParticleInlet.DisablePeriodic) instead. - #### DisableStopAllAtStopTime() @@ -125,12 +121,6 @@ Set the value of “Force Packing” to True. Set the value of “Periodic” to True. - - -#### EnablePeriodicDischarge() - -Deprecated: Use [`EnablePeriodic()`](#generated.RAParticleInlet.EnablePeriodic) instead. - #### EnableStopAllAtStopTime() @@ -153,15 +143,6 @@ Get all available Entry Points. List[[`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RAFeedConveyor`](RAFeedConveyor.md#generated.RAFeedConveyor), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface)] A list of [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry), [`RAFeedConveyor`](RAFeedConveyor.md#generated.RAFeedConveyor), [`RARectangularSurface`](RARectangularSurface.md#generated.RARectangularSurface), [`RACircularSurface`](RACircularSurface.md#generated.RACircularSurface), [`RASurface`](RASurface.md#generated.RASurface). - - -#### GetDischargeTime(unit: str | None = None) - -Deprecated: Use [`GetInjectionDuration()`](#generated.RAParticleInlet.GetInjectionDuration) instead. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - #### GetEntryPoint() @@ -207,12 +188,6 @@ Get the value of “Period”. Get the value of “Periodic”. - - -#### GetPeriodicDischarge() - -Deprecated: Use [`GetPeriodic()`](#generated.RAParticleInlet.GetPeriodic) instead. - #### GetSphInjectionEnabled() @@ -261,12 +236,6 @@ Get the value of “Target Normal Velocity”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m/s”. - - -#### GetTonnageList() - -Deprecated: Use [`GetInputPropertiesList()`](#generated.RAParticleInlet.GetInputPropertiesList) instead. - #### GetUseTargetNormalVelocity() @@ -297,12 +266,6 @@ Get the value of “Uz Local”. Check if the “Force Packing” is enabled. - - -#### IsPeriodicDischargeEnabled() - -Deprecated: Use [`IsPeriodicEnabled()`](#generated.RAParticleInlet.IsPeriodicEnabled) instead. - #### IsPeriodicEnabled() @@ -321,15 +284,14 @@ Check if the “Stop All At Stop Time” is enabled. Check if the “Use Target Normal Velocity” is enabled. - + -#### SetDischargeTime(value: float, unit: str | None = None) +#### RemoveParticle(particle: RAParticle | str) -Deprecated: Use [`SetInjectionDuration()`](#generated.RAParticleInlet.SetInjectionDuration) instead. +Remove a particle from the Particle Inlet input properties list. * **Parameters:** - * **value** – The value to set. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “s”. + **particle** – The particle to remove, either as an [`RAParticle`](RAParticle.md#generated.RAParticle) object or by name. @@ -378,15 +340,6 @@ Set the value of “Periodic”. * **Parameters:** **value** – The value to set. - - -#### SetPeriodicDischarge(value) - -Deprecated: Use [`SetPeriodic()`](#generated.RAParticleInlet.SetPeriodic) instead. - -* **Return type:** - bool - #### SetSphInjectionEnabled(value: bool) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInletProperties.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInletProperties.md index 0e8149d5a9..ec2134fab8 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInletProperties.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleInletProperties.md @@ -25,20 +25,18 @@ input_properties_1.SetMassFlowRate(100, 't/h') **Methods:** | Name | Description | -|----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| -| [`GetAvailableParticles`](#generated.RAParticleInletProperties.GetAvailableParticles)() | Get all available Particles. | -| [`GetMassFlowRate`](#generated.RAParticleInletProperties.GetMassFlowRate)([unit]) | Get the value of "Mass Flow Rate". | -| [`GetModuleProperties`](#generated.RAParticleInletProperties.GetModuleProperties)() | Get the names of the module properties. | -| [`GetModuleProperty`](#generated.RAParticleInletProperties.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | -| [`GetParticle`](#generated.RAParticleInletProperties.GetParticle)() | Get the "Particle". | -| [`GetTemperature`](#generated.RAParticleInletProperties.GetTemperature)([unit]) | Get the value of "Temperature". | -| [`GetTonnage`](#generated.RAParticleInletProperties.GetTonnage)([unit]) | Deprecated: Use [`GetMassFlowRate()`](#generated.RAParticleInletProperties.GetMassFlowRate) instead. | -| [`GetValidOptionsForModuleProperty`](#generated.RAParticleInletProperties.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | -| [`SetMassFlowRate`](#generated.RAParticleInletProperties.SetMassFlowRate)(value[, unit]) | Set the value of "Mass Flow Rate". | -| [`SetModuleProperty`](#generated.RAParticleInletProperties.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | -| [`SetParticle`](#generated.RAParticleInletProperties.SetParticle)(value) | Set the "Particle". | -| [`SetTemperature`](#generated.RAParticleInletProperties.SetTemperature)(value[, unit]) | Set the value of "Temperature". | -| [`SetTonnage`](#generated.RAParticleInletProperties.SetTonnage)(value[, unit]) | Deprecated: Use [`SetMassFlowRate()`](#generated.RAParticleInletProperties.SetMassFlowRate) instead. | +|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [`GetAvailableParticles`](#generated.RAParticleInletProperties.GetAvailableParticles)() | Get all available Particles. | +| [`GetMassFlowRate`](#generated.RAParticleInletProperties.GetMassFlowRate)([unit]) | Get the value of "Mass Flow Rate". | +| [`GetModuleProperties`](#generated.RAParticleInletProperties.GetModuleProperties)() | Get the names of the module properties. | +| [`GetModuleProperty`](#generated.RAParticleInletProperties.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | +| [`GetParticle`](#generated.RAParticleInletProperties.GetParticle)() | Get the "Particle". | +| [`GetTemperature`](#generated.RAParticleInletProperties.GetTemperature)([unit]) | Get the value of "Temperature". | +| [`GetValidOptionsForModuleProperty`](#generated.RAParticleInletProperties.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`SetMassFlowRate`](#generated.RAParticleInletProperties.SetMassFlowRate)(value[, unit]) | Set the value of "Mass Flow Rate". | +| [`SetModuleProperty`](#generated.RAParticleInletProperties.SetModuleProperty)(property_name, value[, unit]) | Set the value of a module property. | +| [`SetParticle`](#generated.RAParticleInletProperties.SetParticle)(value) | Set the "Particle". | +| [`SetTemperature`](#generated.RAParticleInletProperties.SetTemperature)(value[, unit]) | Set the value of "Temperature". | @@ -105,15 +103,6 @@ Get the value of “Temperature”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “K”. - - -#### GetTonnage(unit: str | None = None) - -Deprecated: Use [`GetMassFlowRate()`](#generated.RAParticleInletProperties.GetMassFlowRate) instead. - -* **Parameters:** - **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “t/h”. - #### GetValidOptionsForModuleProperty(property_name) @@ -166,13 +155,3 @@ Set the value of “Temperature”. * **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 “K”. - - - -#### SetTonnage(value: float, unit: str | None = None) - -Deprecated: Use [`SetMassFlowRate()`](#generated.RAParticleInletProperties.SetMassFlowRate) instead. - -* **Parameters:** - * **value** – The value to set. - * **unit** – The unit for value. If no unit is provided, value is assumed to be in “t/h”. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleJointsData.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleJointsData.md index 10b7d3762e..ca917b0c03 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleJointsData.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleJointsData.md @@ -43,10 +43,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNames`](#generated.RAParticleJointsData.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAParticleJointsData.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAParticleJointsData.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAParticleJointsData.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAParticleJointsData.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAParticleJointsData.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAParticleJointsData.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAParticleJointsData.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAParticleJointsData.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAParticleJointsData.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAParticleJointsData.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAParticleJointsData.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAParticleJointsData.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAParticleJointsData.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -56,6 +59,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RAParticleJointsData.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAParticleJointsData.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAParticleJointsData.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAParticleJointsData.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAParticleJointsData.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAParticleJointsData.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IsCollectJointDataEnabled`](#generated.RAParticleJointsData.IsCollectJointDataEnabled)() | Check if the "Collect Joint Data" is enabled. | @@ -126,7 +130,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -138,7 +142,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -205,30 +209,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -433,99 +435,87 @@ Set the value of “Collect Joint Data” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -534,39 +524,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -600,16 +586,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -621,7 +605,7 @@ Get the value of “Collect Joint Data”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -663,25 +647,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -703,13 +727,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -717,26 +739,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -749,31 +758,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -801,8 +806,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -840,47 +843,56 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -892,13 +904,13 @@ Check if the “Collect Joint Data” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -908,12 +920,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleTimeSelectionProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleTimeSelectionProcess.md index d924a42225..f26c91b0bf 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleTimeSelectionProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleTimeSelectionProcess.md @@ -15,8 +15,9 @@ Select particles over a time range. **Methods:** -| [`AddCurve`](#generated.RAParticleTimeSelectionProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| Name | Description | |-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAParticleTimeSelectionProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | | [`AddCustomCurve`](#generated.RAParticleTimeSelectionProcess.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | | [`AddCustomProperty`](#generated.RAParticleTimeSelectionProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | | [`AddGridFunction`](#generated.RAParticleTimeSelectionProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | @@ -41,10 +42,13 @@ Select particles over a time range. | [`GetCurveNames`](#generated.RAParticleTimeSelectionProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAParticleTimeSelectionProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAParticleTimeSelectionProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAParticleTimeSelectionProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAParticleTimeSelectionProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAParticleTimeSelectionProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAParticleTimeSelectionProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAParticleTimeSelectionProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAParticleTimeSelectionProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAParticleTimeSelectionProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -56,6 +60,7 @@ Select particles over a time range. | [`GetTimeStatistics`](#generated.RAParticleTimeSelectionProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAParticleTimeSelectionProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAParticleTimeSelectionProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAParticleTimeSelectionProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAParticleTimeSelectionProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAParticleTimeSelectionProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAParticleTimeSelectionProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -127,7 +132,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -139,7 +144,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -206,30 +211,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -422,99 +425,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -523,39 +514,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -589,22 +576,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -646,25 +631,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -686,13 +711,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -700,26 +723,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -732,31 +742,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -809,8 +815,6 @@ Get a dictionary with the current time range configuration. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -848,59 +852,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -910,12 +923,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleToContactProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleToContactProcess.md index 2052b7f445..9699f03e2e 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleToContactProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticleToContactProcess.md @@ -15,8 +15,9 @@ Process that computes contacts from a selection of particles. **Methods:** -| [`AddCurve`](#generated.RAParticleToContactProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| Name | Description | |-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAParticleToContactProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | | [`AddCustomCurve`](#generated.RAParticleToContactProcess.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | | [`AddCustomProperty`](#generated.RAParticleToContactProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | | [`AddGridFunction`](#generated.RAParticleToContactProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | @@ -41,10 +42,13 @@ Process that computes contacts from a selection of particles. | [`GetCurveNames`](#generated.RAParticleToContactProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAParticleToContactProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAParticleToContactProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAParticleToContactProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAParticleToContactProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAParticleToContactProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAParticleToContactProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAParticleToContactProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAParticleToContactProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAParticleToContactProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAParticleToContactProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAParticleToContactProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAParticleToContactProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAParticleToContactProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -55,6 +59,7 @@ Process that computes contacts from a selection of particles. | [`GetTimeStatistics`](#generated.RAParticleToContactProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAParticleToContactProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAParticleToContactProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAParticleToContactProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAParticleToContactProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAParticleToContactProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAParticleToContactProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -124,7 +129,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -136,7 +141,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -203,30 +208,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -419,99 +422,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -520,39 +511,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -586,22 +573,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -643,25 +628,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -683,13 +708,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -697,26 +720,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -729,31 +739,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -796,8 +802,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -835,59 +839,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -897,12 +910,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticles.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticles.md index d5f0d3182e..80c37383fa 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticles.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAParticles.md @@ -15,8 +15,9 @@ Rocky api Particles model. **Methods:** -| [`AddCurve`](#generated.RAParticles.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| Name | Description | |----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RAParticles.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | | [`AddCustomCurve`](#generated.RAParticles.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | | [`AddCustomProperty`](#generated.RAParticles.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | | [`AddGridFunction`](#generated.RAParticles.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | @@ -41,10 +42,13 @@ Rocky api Particles model. | [`GetCurveNames`](#generated.RAParticles.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAParticles.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAParticles.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAParticles.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAParticles.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAParticles.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAParticles.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAParticles.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAParticles.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAParticles.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAParticles.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAParticles.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAParticles.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RAParticles.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | @@ -55,6 +59,7 @@ Rocky api Particles model. | [`GetTimeStatistics`](#generated.RAParticles.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAParticles.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAParticles.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAParticles.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAParticles.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAParticles.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAParticles.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -124,7 +129,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -136,7 +141,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -203,30 +208,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -419,99 +422,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -520,39 +511,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -586,22 +573,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -643,25 +628,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -683,13 +708,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -697,26 +720,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -729,31 +739,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -796,8 +802,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -835,59 +839,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -897,12 +910,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPendulum.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPendulum.md index 8ed68e14ca..cf63cbb07e 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPendulum.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPendulum.md @@ -25,8 +25,9 @@ pendulum = motion_1.GetTypeObject() **Methods:** -| [`GetAmplitudeVariation`](#generated.RAPendulum.GetAmplitudeVariation)([unit]) | Get the value of "Amplitude Variation". | +| Name | Description | |---------------------------------------------------------------------------------------|-------------------------------------------| +| [`GetAmplitudeVariation`](#generated.RAPendulum.GetAmplitudeVariation)([unit]) | Get the value of "Amplitude Variation". | | [`GetDirection`](#generated.RAPendulum.GetDirection)() | Get the value of "Direction". | | [`GetFrequencyVariation`](#generated.RAPendulum.GetFrequencyVariation)([unit]) | Get the value of "Frequency Variation". | | [`GetInitialAmplitude`](#generated.RAPendulum.GetInitialAmplitude)([unit]) | Get the value of "Initial Amplitude". | diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneGroup.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneGroup.md new file mode 100644 index 0000000000..5f6f79bd80 --- /dev/null +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneGroup.md @@ -0,0 +1,213 @@ + + +# RAPlaneGroup + + + + + + +### *class* RAPlaneGroup + +**Methods:** + +| Name | +| --------------------------------------------------------------------------------------------------------------- | +| [`AddCurve`](#generated.RAPlaneGroup.AddCurve)(curve_name, timesteps, values, unit) | +| [`GetCurve`](#generated.RAPlaneGroup.GetCurve)(curve_name[, simulation_name, ...]) | +| [`GetCurveNames`](#generated.RAPlaneGroup.GetCurveNames)([simulation_name]) | +| [`GetCurveNamesAssociation`](#generated.RAPlaneGroup.GetCurveNamesAssociation)([simulation_name]) | +| [`GetElementCurve`](#generated.RAPlaneGroup.GetElementCurve)(element_name, curve_name[, ...]) | +| [`GetMode`](#generated.RAPlaneGroup.GetMode)() | +| [`GetNumpyCurve`](#generated.RAPlaneGroup.GetNumpyCurve)(curve_name[, unit, realization]) | +| [`GetOrientation`](#generated.RAPlaneGroup.GetOrientation)([unit]) | +| [`GetOrientationFromAngleAndVector`](#generated.RAPlaneGroup.GetOrientationFromAngleAndVector)([unit]) | +| [`GetOrientationFromAngles`](#generated.RAPlaneGroup.GetOrientationFromAngles)([unit]) | +| [`GetOrientationFromBasisVector`](#generated.RAPlaneGroup.GetOrientationFromBasisVector)() | +| [`GetOrigin`](#generated.RAPlaneGroup.GetOrigin)([unit]) | +| [`GetType`](#generated.RAPlaneGroup.GetType)() | +| [`SetMode`](#generated.RAPlaneGroup.SetMode)(plane_mode) | +| [`SetOrientation`](#generated.RAPlaneGroup.SetOrientation)(rotation[, unit]) | +| [`SetOrientationFromAngleAndVector`](#generated.RAPlaneGroup.SetOrientationFromAngleAndVector)(angle, vector) | +| [`SetOrientationFromAngles`](#generated.RAPlaneGroup.SetOrientationFromAngles)(rotation[, unit, ...]) | +| [`SetOrientationFromBasisVector`](#generated.RAPlaneGroup.SetOrientationFromBasisVector)(vector_x, ...) | +| [`SetOrigin`](#generated.RAPlaneGroup.SetOrigin)(x, y, z) | +| [`SetType`](#generated.RAPlaneGroup.SetType)(plane_type) | + + + +#### AddCurve(curve_name, timesteps, values, unit, realization=None, timesteps_unit=None, initial_date=None) + +Add a curve to the element with a time-steps domain + +* **Parameters:** + * **curve_name** (*unicode* *or* *SemanticAssociation*) – The curve’s name or semantic association + * **timesteps** (*list* *(**TimeStep* *) or* *list* *(**float* *) or* *TimeSet*) – The list of time-steps, in such case a initial date can be provided + The list of elapsed time as floats, in such case a timesteps_units can be + provide or days will be used + The curve’s TimeSet + * **values** (*list* *(**float* *)*) – The list of curve image values + * **unit** (*unicode* *or* *Quantity*) – The curve image unit or quantity + * **realization** (*unicode*) – An additional keyword to identify the curve realization + * **timesteps_units** (*unicode*) – The elapsed time values unit + It should be given if a list of floats is used to define the time-set + If not given days are assumed + * **initial_date** (*tuple* *(**int* *,* *int* *,* *int* *,* *int* *,* *int* *,* *int* *) or* *TimeStep*) – The initial date for the time-steps given + A tuple with the year, month, day, hour, minute and seconds + Or a TimeStep + + + +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) + +Return the curves for the given element and name. + +* **Parameters:** + * **curve_name** (*unicode*) – The name of the curve. + * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the curve from. + * **realization** (*unicode*) – An additional keyword to identify the curve realization + * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + + +#### GetCurveNames(simulation_name=None) + +@param simulation_name: unicode +: An optional parameter for defining the simulation to get the curve from. + +* **Returns:** + list(str) + The list of curve names + + + +#### GetCurveNamesAssociation(simulation_name=None) + +Get this element’s curve names. + +* **Parameters:** + **simulation_name** (*unicode*) – The name of the simulation to query the curve names + If None is given the current element simulation will be used +* **Return type:** + dict(unicode, ISemanticAssociation) +* **Returns:** + The curve names for this element in the given simulation name + + + +#### GetElementCurve(element_name, curve_name, simulation_name=None, realization=None, time_step=None) + +Return the curves for the given element and name. + +* **Parameters:** + * **element_name** (*unicode*) – The name of the element + * **curve_name** (*unicode*) – The name of the curve + * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the curve from. + * **realization** (*unicode*) – An additional keyword to identify the curve realization + * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + + +#### GetMode() + +* **Returns:** + ‘Exact’ or ‘Select’, whether the plane process is selecting or cutting the cell’s from the input process. + + + +#### GetNumpyCurve(curve_name, unit=None, realization=None) + +Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. + + + +#### GetOrientation(unit: str = 'dega') + +Get the orientation angles. For more specific cases, see: “GetOrientationFromAngles”, +“GetOrientationFromAngleAndVector” and “GetOrientationFromBasisVector”. + + + +#### GetOrientationFromAngleAndVector(unit: str = 'dega') + +Get the current orientation in the form of an angle and a vector. + + + +#### GetOrientationFromAngles(unit: str = 'dega') + +Get the current orientation in the form of angles. + + + +#### GetOrientationFromBasisVector() + +Get the current orientation in the form of three basis vectors. + + + +#### GetOrigin(unit=None) + +* **Returns:** + Returns the X, Y and Z plane origin + + + +#### GetType() + +* **Returns:** + ‘Cut’ or ‘Clip’, whether the plane process is cutting or clipping the input process. + + + +#### SetMode(plane_mode: str) + +* **Parameters:** + **plane_mode** – ‘Exact’ or ‘Select’ + Sets whether the plane process is selecting or cutting the cell’s from the input process + + + +#### SetOrientation(rotation: tuple[float, float, float], unit: str = 'dega') + +The rotation is the angles in x, y and z of the rotation in the given unit. For more +specific methods, see: “SetOrientationFromAngles”, “SetOrientationFromAngleAndVector” and +“SetOrientationFromBasisVector”. + + + +#### SetOrientationFromAngleAndVector(angle: float, vector: tuple[float, float, float], unit: str = 'dega') + +The rotation uses the angle and a vector, using unit and changes the orientation mode to +Angle and Vector. + + + +#### SetOrientationFromAngles(rotation: tuple[float, float, float], unit: str = 'dega', local_angles: bool = True, order: str = 'XYZ') + +The rotation is the angles in x, y and z of the rotation. The default unit is dega. +Additionally, local_angles can be used as well an order of the values via kwargs. + + + +#### SetOrientationFromBasisVector(vector_x: tuple[float, float, float], vector_y: tuple[float, float, float], vector_z: tuple[float, float, float]) + +Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. + + + +#### SetOrigin(x: float, y: float, z: float) + +* **Parameters:** + * **x** + * **y** + * **z** + + + +#### SetType(plane_type: str) + +* **Parameters:** + **plane_type** – ‘Cut’ or ‘Clip’, sets whether the plane process is cutting or clipping the input process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneProcess.md index 3a13ece45d..3dcadf1cc9 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPlaneProcess.md @@ -13,78 +13,78 @@ generally aren't instantiated by the user). --> **Methods:** -| Name | Description | -|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCurve`](#generated.RAPlaneProcess.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -| [`AddCustomCurve`](#generated.RAPlaneProcess.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`AddCustomProperty`](#generated.RAPlaneProcess.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RAPlaneProcess.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RAPlaneProcess.CreateCurveOutputVariable)(curve_name[, ...]) | Used to create an output variable based on a curve which doesn't change at each new timestep (i.e.: a curve with a single value for each time). | -| [`CreateGridFunction`](#generated.RAPlaneProcess.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RAPlaneProcess.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAPlaneProcess.CreateGridFunctionStatisticOutputVariable)(...) | Used to create an output variable based on a grid function statistic (i.e.: will get a grid function, compute its statistic based on statistic_operation and then based on the statistic values will apply the operation to get a single scalar). | -| [`CreateTransientCurveOutputVariable`](#generated.RAPlaneProcess.CreateTransientCurveOutputVariable)(curve_name) | Used to create an output variable based on a curve for which there's a completely new representation for each time step -- such as Power : Impact X Belt Width (i.e.: will get the curve multiple times based on the time range, compute a value for each time based on the operation, to convert the multiple curves into a single curve and then will apply the time_operation to get a single scalar from those values). | -| [`EditCustomCurve`](#generated.RAPlaneProcess.EditCustomCurve)(edit_curve[, new_name, ...]) | Edit a custom curve saved in the database. :param edit_curve: The name of the curve to be edited. :param new_name: The new name of the curve to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`EditCustomProperty`](#generated.RAPlaneProcess.EditCustomProperty)(edit_property[, ...]) | Edit a custom property saved in the database. :param edit_property: The name of the property to be edited. :param new_name: The new name of the property to be set. :param sources: A dict pointing the variable used to the property association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`GetActivesArray`](#generated.RAPlaneProcess.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetBoundingBox`](#generated.RAPlaneProcess.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCellAreaAsArray`](#generated.RAPlaneProcess.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RAPlaneProcess.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RAPlaneProcess.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RAPlaneProcess.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RAPlaneProcess.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RAPlaneProcess.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RAPlaneProcess.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RAPlaneProcess.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCurve`](#generated.RAPlaneProcess.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RAPlaneProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RAPlaneProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetElementCurve`](#generated.RAPlaneProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetGeometryQuantity`](#generated.RAPlaneProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`GetGeometryUnit`](#generated.RAPlaneProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | -| [`GetGridFunction`](#generated.RAPlaneProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAPlaneProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | -| [`GetMeshColoring`](#generated.RAPlaneProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMode`](#generated.RAPlaneProcess.GetMode)() | | -| [`GetNormal`](#generated.RAPlaneProcess.GetNormal)() | Returns the X, Y and Z plane normal | -| [`GetNumberOfCells`](#generated.RAPlaneProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RAPlaneProcess.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfParticles`](#generated.RAPlaneProcess.GetNumberOfParticles)(time_step) | Get the total number of particles in this selection. | -| [`GetNumpyCurve`](#generated.RAPlaneProcess.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOrientation`](#generated.RAPlaneProcess.GetOrientation)([unit]) | Get the orientation angles. | -| [`GetOrientationFromAngleAndVector`](#generated.RAPlaneProcess.GetOrientationFromAngleAndVector)([unit]) | Get the current orientation in the form of an angle and a vector. | -| [`GetOrientationFromAngles`](#generated.RAPlaneProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | -| [`GetOrientationFromBasisVector`](#generated.RAPlaneProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | -| [`GetOrigin`](#generated.RAPlaneProcess.GetOrigin)() | | -| [`GetOutputVariableValue`](#generated.RAPlaneProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetPlaneNormal`](#generated.RAPlaneProcess.GetPlaneNormal)() | Deprecated: Use GetNormal instead | -| [`GetPlaneOrigin`](#generated.RAPlaneProcess.GetPlaneOrigin)() | Deprecated: Use GetOrigin instead | -| [`GetTimeSet`](#generated.RAPlaneProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RAPlaneProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RAPlaneProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTopologyShape`](#generated.RAPlaneProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetType`](#generated.RAPlaneProcess.GetType)() | | -| [`HasGridFunction`](#generated.RAPlaneProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | -| [`IsCellActive`](#generated.RAPlaneProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IterCellVertices`](#generated.RAPlaneProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RAPlaneProcess.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`IterParticles`](#generated.RAPlaneProcess.IterParticles)(time_step) | Iterate on particles in this selection at the given time. | -| [`Modified`](#generated.RAPlaneProcess.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RAPlaneProcess.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RAPlaneProcess.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RAPlaneProcess.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RAPlaneProcess.RemoveProcess)() | Removes the process from the project. | -| [`SetCurrentTimeStep`](#generated.RAPlaneProcess.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetMode`](#generated.RAPlaneProcess.SetMode)(plane_mode) | | -| [`SetNormal`](#generated.RAPlaneProcess.SetNormal)(x, y, z) | Set the X, Y and Z parameters of the plane normal | -| [`SetOrientation`](#generated.RAPlaneProcess.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | -| [`SetOrientationFromAngleAndVector`](#generated.RAPlaneProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | -| [`SetOrientationFromAngles`](#generated.RAPlaneProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | -| [`SetOrientationFromBasisVector`](#generated.RAPlaneProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetOrigin`](#generated.RAPlaneProcess.SetOrigin)(x, y, z) | | -| [`SetPlaneNormal`](#generated.RAPlaneProcess.SetPlaneNormal)(x, y, z) | Deprecated: Use SetNormal instead | -| [`SetPlaneOrigin`](#generated.RAPlaneProcess.SetPlaneOrigin)(x, y, z) | Deprecated: Use SetOrigin instead | -| [`SetType`](#generated.RAPlaneProcess.SetType)(plane_type) | | +| Name | +| ------------------------------------------------------------------------------------------------------------------------- | +| [`AddCurve`](#generated.RAPlaneProcess.AddCurve)(curve_name, timesteps, values, unit) | +| [`AddCustomCurve`](#generated.RAPlaneProcess.AddCustomCurve)(name[, curve_type, ...]) | +| [`AddCustomProperty`](#generated.RAPlaneProcess.AddCustomProperty)(name[, property_type, ...]) | +| [`AddGridFunction`](#generated.RAPlaneProcess.AddGridFunction)(grid_function_name, ...[, ...]) | +| [`CreateCurveOutputVariable`](#generated.RAPlaneProcess.CreateCurveOutputVariable)(curve_name[, ...]) | +| [`CreateGridFunction`](#generated.RAPlaneProcess.CreateGridFunction)(values[, location, time_step]) | +| [`CreateGridFunctionArrayOnCells`](#generated.RAPlaneProcess.CreateGridFunctionArrayOnCells)([time_step]) | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RAPlaneProcess.CreateGridFunctionStatisticOutputVariable)(...) | +| [`CreateTransientCurveOutputVariable`](#generated.RAPlaneProcess.CreateTransientCurveOutputVariable)(curve_name) | +| [`EditCustomCurve`](#generated.RAPlaneProcess.EditCustomCurve)(edit_curve[, new_name, ...]) | +| [`EditCustomProperty`](#generated.RAPlaneProcess.EditCustomProperty)(edit_property[, ...]) | +| [`GetActivesArray`](#generated.RAPlaneProcess.GetActivesArray)([time_step]) | +| [`GetBoundingBox`](#generated.RAPlaneProcess.GetBoundingBox)([unit, time_step]) | +| [`GetCellAreaAsArray`](#generated.RAPlaneProcess.GetCellAreaAsArray)([time_step]) | +| [`GetCellCenterAsArray`](#generated.RAPlaneProcess.GetCellCenterAsArray)([time_step]) | +| [`GetCellDzAsArray`](#generated.RAPlaneProcess.GetCellDzAsArray)([time_step]) | +| [`GetCellFromIJK`](#generated.RAPlaneProcess.GetCellFromIJK)(i, j, k[, time_step]) | +| [`GetCellIJK`](#generated.RAPlaneProcess.GetCellIJK)(cell_handle[, time_step]) | +| [`GetCellNumberOfVertices`](#generated.RAPlaneProcess.GetCellNumberOfVertices)(cell[, time_step]) | +| [`GetCellPointsAsFunction`](#generated.RAPlaneProcess.GetCellPointsAsFunction)([time_step]) | +| [`GetCellVolumeAsArray`](#generated.RAPlaneProcess.GetCellVolumeAsArray)([time_step]) | +| [`GetCurve`](#generated.RAPlaneProcess.GetCurve)(curve_name[, simulation_name, ...]) | +| [`GetCurveNames`](#generated.RAPlaneProcess.GetCurveNames)([simulation_name]) | +| [`GetCurveNamesAssociation`](#generated.RAPlaneProcess.GetCurveNamesAssociation)([simulation_name]) | +| [`GetElementCurve`](#generated.RAPlaneProcess.GetElementCurve)(element_name, curve_name[, ...]) | +| [`GetFacePositions`](#generated.RAPlaneProcess.GetFacePositions)([time_step]) | +| [`GetFaceVertices`](#generated.RAPlaneProcess.GetFaceVertices)([time_step]) | +| [`GetGeometryQuantity`](#generated.RAPlaneProcess.GetGeometryQuantity)() | +| [`GetGeometryTransform`](#generated.RAPlaneProcess.GetGeometryTransform)([time_step]) | +| [`GetGeometryUnit`](#generated.RAPlaneProcess.GetGeometryUnit)() | +| [`GetGridFunction`](#generated.RAPlaneProcess.GetGridFunction)(grid_function_name[, ...]) | +| [`GetGridFunctionNames`](#generated.RAPlaneProcess.GetGridFunctionNames)([translated, context]) | +| [`GetMeshColoring`](#generated.RAPlaneProcess.GetMeshColoring)(window) | +| [`GetMode`](#generated.RAPlaneProcess.GetMode)() | +| [`GetNumberOfCells`](#generated.RAPlaneProcess.GetNumberOfCells)([time_step]) | +| [`GetNumberOfNodes`](#generated.RAPlaneProcess.GetNumberOfNodes)([time_step]) | +| [`GetNumberOfParticles`](#generated.RAPlaneProcess.GetNumberOfParticles)(time_step) | +| [`GetNumpyCurve`](#generated.RAPlaneProcess.GetNumpyCurve)(curve_name[, unit, realization]) | +| [`GetOrientation`](#generated.RAPlaneProcess.GetOrientation)([unit]) | +| [`GetOrientationFromAngleAndVector`](#generated.RAPlaneProcess.GetOrientationFromAngleAndVector)([unit]) | +| [`GetOrientationFromAngles`](#generated.RAPlaneProcess.GetOrientationFromAngles)([unit]) | +| [`GetOrientationFromBasisVector`](#generated.RAPlaneProcess.GetOrientationFromBasisVector)() | +| [`GetOrigin`](#generated.RAPlaneProcess.GetOrigin)([unit]) | +| [`GetOutputVariableValue`](#generated.RAPlaneProcess.GetOutputVariableValue)(variable_name) | +| [`GetRelativeRotationVector`](#generated.RAPlaneProcess.GetRelativeRotationVector)() | +| [`GetTimeSet`](#generated.RAPlaneProcess.GetTimeSet)() | +| [`GetTimeStatistics`](#generated.RAPlaneProcess.GetTimeStatistics)() | +| [`GetTimeStep`](#generated.RAPlaneProcess.GetTimeStep)(time_step[, accept_global]) | +| [`GetTopologyShape`](#generated.RAPlaneProcess.GetTopologyShape)([time_step]) | +| [`GetType`](#generated.RAPlaneProcess.GetType)() | +| [`GetVertices`](#generated.RAPlaneProcess.GetVertices)([time_step]) | +| [`HasGridFunction`](#generated.RAPlaneProcess.HasGridFunction)(grid_function_name) | +| [`IsCellActive`](#generated.RAPlaneProcess.IsCellActive)(i, j, k[, time_step]) | +| [`IterCellVertices`](#generated.RAPlaneProcess.IterCellVertices)(cell[, time_step]) | +| [`IterCells`](#generated.RAPlaneProcess.IterCells)([time_step]) | +| [`IterParticles`](#generated.RAPlaneProcess.IterParticles)(time_step) | +| [`Modified`](#generated.RAPlaneProcess.Modified)(\*args, \*\*kwargs) | +| [`RemoveCustomCurve`](#generated.RAPlaneProcess.RemoveCustomCurve)(name) | +| [`RemoveCustomProperty`](#generated.RAPlaneProcess.RemoveCustomProperty)(name) | +| [`RemoveOutputVariable`](#generated.RAPlaneProcess.RemoveOutputVariable)(variable_name) | +| [`RemoveProcess`](#generated.RAPlaneProcess.RemoveProcess)() | +| [`SetCurrentTimeStep`](#generated.RAPlaneProcess.SetCurrentTimeStep)(time_step) | +| [`SetMode`](#generated.RAPlaneProcess.SetMode)(plane_mode) | +| [`SetOrientation`](#generated.RAPlaneProcess.SetOrientation)(rotation[, unit]) | +| [`SetOrientationFromAngleAndVector`](#generated.RAPlaneProcess.SetOrientationFromAngleAndVector)(angle, vector) | +| [`SetOrientationFromAngles`](#generated.RAPlaneProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | +| [`SetOrientationFromBasisVector`](#generated.RAPlaneProcess.SetOrientationFromBasisVector)(vector_x, ...) | +| [`SetOrigin`](#generated.RAPlaneProcess.SetOrigin)(x, y, z) | +| [`SetRelativeRotationVector`](#generated.RAPlaneProcess.SetRelativeRotationVector)(x, y, z) | +| [`SetType`](#generated.RAPlaneProcess.SetType)(plane_type) | @@ -143,7 +143,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -155,7 +155,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -222,30 +222,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -438,99 +436,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -539,39 +525,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -605,22 +587,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -662,25 +642,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -702,13 +722,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -716,26 +734,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -753,39 +758,29 @@ Get the RAMeshColoring related to the current object and a window. * **Returns:** ‘Exact’ or ‘Select’, whether the plane process is selecting or cutting the cell’s from the input process. - - -#### GetNormal() - -Returns the X, Y and Z plane normal - -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -837,7 +832,7 @@ Get the current orientation in the form of three basis vectors. -#### GetOrigin() +#### GetOrigin(unit=None) * **Returns:** Returns the X, Y and Z plane origin @@ -854,17 +849,11 @@ Get the value of a previously-created output variable. Returns a scalar with the value and unit for the given variable_name or None if no variable was found with the given name or if it couldn’t be computed. - - -#### GetPlaneNormal() - -Deprecated: Use GetNormal instead + - +#### GetRelativeRotationVector() -#### GetPlaneOrigin() - -Deprecated: Use GetOrigin instead +Returns the X, Y and Z plane normal @@ -872,8 +861,6 @@ Deprecated: Use GetOrigin instead Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -911,16 +898,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -931,46 +916,57 @@ Get the shape of the topology (similar to the shape of numpy arrays). * **Returns:** ‘Cut’ or ‘Clip’, whether the plane process is cutting or clipping the input process. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -980,12 +976,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1068,12 +1064,6 @@ Sets the current time step. **plane_mode** – ‘Exact’ or ‘Select’ Sets whether the plane process is selecting or cutting the cell’s from the input process - - -#### SetNormal(x: float, y: float, z: float) - -Set the X, Y and Z parameters of the plane normal - #### SetOrientation(rotation: tuple[float, float, float], unit: str = 'dega') @@ -1111,17 +1101,11 @@ Sets the rotation using three basis vector and changes the orientation mode to B * **y** * **z** - - -#### SetPlaneNormal(x: float, y: float, z: float) - -Deprecated: Use SetNormal instead + - +#### SetRelativeRotationVector(x: float, y: float, z: float) -#### SetPlaneOrigin(x: float, y: float, z: float) - -Deprecated: Use SetOrigin instead +Set the X, Y and Z parameters of the plane normal diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPointCloud.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPointCloud.md index 5510b575f8..b7e377219a 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPointCloud.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPointCloud.md @@ -54,11 +54,14 @@ point_cloud_2 = point_cloud_collection[1] | [`GetCurveNamesAssociation`](#generated.RAPointCloud.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAPointCloud.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | | [`GetEnablePeriodic`](#generated.RAPointCloud.GetEnablePeriodic)() | Get the value of "Enable Periodic". | +| [`GetFacePositions`](#generated.RAPointCloud.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAPointCloud.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFilePath`](#generated.RAPointCloud.GetFilePath)() | Get the value of "File Path". | | [`GetGeometryQuantity`](#generated.RAPointCloud.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAPointCloud.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAPointCloud.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAPointCloud.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAPointCloud.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAPointCloud.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAPointCloud.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetModuleProperties`](#generated.RAPointCloud.GetModuleProperties)() | Get the names of the module properties. | | [`GetModuleProperty`](#generated.RAPointCloud.GetModuleProperty)(property_name[, unit]) | Get the value of a module property. | @@ -70,11 +73,13 @@ point_cloud_2 = point_cloud_collection[1] | [`GetPeriodicStartTime`](#generated.RAPointCloud.GetPeriodicStartTime)([unit]) | Get the value of "Periodic Start Time". | | [`GetPeriodicStopTime`](#generated.RAPointCloud.GetPeriodicStopTime)([unit]) | Get the value of "Periodic Stop Time". | | [`GetSearchCutOff`](#generated.RAPointCloud.GetSearchCutOff)() | Get the value of "Search Cut Off". | +| [`GetSearchCutOffDistance`](#generated.RAPointCloud.GetSearchCutOffDistance)([unit]) | Get the value of "Search Cut Off Distance". | | [`GetTimeSet`](#generated.RAPointCloud.GetTimeSet)() | Get the list of time-steps associated to the grid. | | [`GetTimeStatistics`](#generated.RAPointCloud.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAPointCloud.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAPointCloud.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | | [`GetValidOptionsForModuleProperty`](#generated.RAPointCloud.GetValidOptionsForModuleProperty)(property_name) | Get all valid options only for properties that have a list of possible options. | +| [`GetVertices`](#generated.RAPointCloud.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAPointCloud.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAPointCloud.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IsPeriodicEnabled`](#generated.RAPointCloud.IsPeriodicEnabled)() | Check if the "Periodic" is enabled. | @@ -94,6 +99,7 @@ point_cloud_2 = point_cloud_collection[1] | [`SetPeriodicStartTime`](#generated.RAPointCloud.SetPeriodicStartTime)(value[, unit]) | Set the value of "Periodic Start Time". | | [`SetPeriodicStopTime`](#generated.RAPointCloud.SetPeriodicStopTime)(value[, unit]) | Set the value of "Periodic Stop Time". | | [`SetSearchCutOff`](#generated.RAPointCloud.SetSearchCutOff)(value) | Set the value of "Search Cut Off". | +| [`SetSearchCutOffDistance`](#generated.RAPointCloud.SetSearchCutOffDistance)(value[, unit]) | Set the value of "Search Cut Off Distance". | @@ -152,7 +158,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -164,7 +170,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -231,30 +237,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -459,99 +463,87 @@ Set the value of “Periodic” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -560,39 +552,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -626,22 +614,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -689,6 +675,35 @@ Return the curves for the given element and name. Get the value of “Enable Periodic”. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFilePath() @@ -701,19 +716,30 @@ Get the value of “File Path”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -735,13 +761,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -749,26 +773,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -816,31 +827,27 @@ Get the value of a module property. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -886,14 +893,21 @@ Get the value of “Periodic Stop Time”. Get the value of “Search Cut Off”. + + +#### GetSearchCutOffDistance(unit: str | None = None) + +Get the value of “Search Cut Off Distance”. + +* **Parameters:** + **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + #### GetTimeSet() Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -931,16 +945,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -955,34 +967,45 @@ Get all valid options only for properties that have a list of possible options. * **Return type:** List[str] + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1000,13 +1023,13 @@ Returns True if the Point Cloud is transient, False otherwise. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1016,12 +1039,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1110,7 +1133,7 @@ Set the value of a module property. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. @@ -1145,3 +1168,13 @@ Set the value of “Search Cut Off”. * **Parameters:** **value** – The value to set. + + + +#### SetSearchCutOffDistance(value: str | float, unit: str | None = None) + +Set the value of “Search Cut Off 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”. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPolyhedronProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPolyhedronProcess.md index b837fbeb05..21e4716853 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAPolyhedronProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAPolyhedronProcess.md @@ -42,10 +42,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNames`](#generated.RAPolyhedronProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RAPolyhedronProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RAPolyhedronProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAPolyhedronProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAPolyhedronProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAPolyhedronProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAPolyhedronProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAPolyhedronProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAPolyhedronProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAPolyhedronProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAPolyhedronProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RAPolyhedronProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMotionFrame`](#generated.RAPolyhedronProcess.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RAPolyhedronProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | @@ -57,13 +60,12 @@ generally aren't instantiated by the user). --> | [`GetOrientationFromAngles`](#generated.RAPolyhedronProcess.GetOrientationFromAngles)([unit]) | Get the current orientation in the form of angles. | | [`GetOrientationFromBasisVector`](#generated.RAPolyhedronProcess.GetOrientationFromBasisVector)() | Get the current orientation in the form of three basis vectors. | | [`GetOutputVariableValue`](#generated.RAPolyhedronProcess.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetRotation`](#generated.RAPolyhedronProcess.GetRotation)([unit]) | | | [`GetScale`](#generated.RAPolyhedronProcess.GetScale)([unit]) | Get the value of "Scale". | -| [`GetSize`](#generated.RAPolyhedronProcess.GetSize)([unit]) | | | [`GetTimeSet`](#generated.RAPolyhedronProcess.GetTimeSet)() | Get the list of time-steps associated to the grid. | | [`GetTimeStatistics`](#generated.RAPolyhedronProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RAPolyhedronProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAPolyhedronProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RAPolyhedronProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAPolyhedronProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAPolyhedronProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAPolyhedronProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -81,10 +83,8 @@ generally aren't instantiated by the user). --> | [`SetOrientationFromAngleAndVector`](#generated.RAPolyhedronProcess.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | | [`SetOrientationFromAngles`](#generated.RAPolyhedronProcess.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | | [`SetOrientationFromBasisVector`](#generated.RAPolyhedronProcess.SetOrientationFromBasisVector)(vector_x, ...) | Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. | -| [`SetRotation`](#generated.RAPolyhedronProcess.SetRotation)(x, y, z[, unit]) | Sets the Polyhedron X, Y and Z rotation | | [`SetSTL`](#generated.RAPolyhedronProcess.SetSTL)(filename[, mesh_unit]) | Sets the Polyhedron file | | [`SetScale`](#generated.RAPolyhedronProcess.SetScale)(values[, unit]) | Set the values of "Scale". | -| [`SetSize`](#generated.RAPolyhedronProcess.SetSize)(x, y, z[, unit]) | Sets the Polyhedron X, Y and Z magnitude | @@ -143,7 +143,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -155,7 +155,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -222,30 +222,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -438,99 +436,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -539,39 +525,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -605,16 +587,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -636,7 +616,7 @@ Get the Process center position considering the assigned motion. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -678,25 +658,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -718,13 +738,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -732,26 +750,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -771,31 +776,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -857,13 +858,6 @@ Get the value of a previously-created output variable. Returns a scalar with the value and unit for the given variable_name or None if no variable was found with the given name or if it couldn’t be computed. - - -#### GetRotation(unit: str | None = None) - -* **Returns:** - Returns the X, Y and Z Polyhedron rotation - #### GetScale(unit: str | None = None) @@ -873,21 +867,12 @@ Get the value of “Scale”. * **Parameters:** **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. - - -#### GetSize(unit: str | None = None) - -* **Returns:** - Returns the X, Y and Z Polyhedron magnitude - #### GetTimeSet() Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -925,59 +910,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -987,12 +981,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1081,7 +1075,7 @@ Sets the current time step. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. @@ -1116,18 +1110,6 @@ Additionally, local_angles can be used as well an order of the values via kwargs Sets the rotation using three basis vector and changes the orientation mode to Basis Vector. - - -#### SetRotation(x: float, y: float, z: float, unit: str | None = None) - -Sets the Polyhedron X, Y and Z rotation - -* **Parameters:** - * **x** – The X rotation - * **y** – The Y rotation - * **z** – The Z rotation - * **unit** – The unit of the given values or None if given in degrees (dega) - #### SetSTL(filename: str, mesh_unit: str | None = None) @@ -1150,15 +1132,3 @@ Set the values of “Scale”. * **unit** – The unit for values. If no unit is provided, values is assumed to be in “m”. * **Raises:** **RockyApiError** – If values doesn’t have exactly 3 elements. - - - -#### SetSize(x: float, y: float, z: float, unit: str | None = None) - -Sets the Polyhedron X, Y and Z magnitude - -* **Parameters:** - * **x** – The X magnitude - * **y** – The Y magnitude - * **z** – The Z magnitude - * **unit** – The unit of the given values or None if given in meters (m) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAProject.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAProject.md index 32827aab97..a3ef3fbcda 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAProject.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAProject.md @@ -43,6 +43,7 @@ project.SaveProjectForRestart('my_restart_project.rocky', timestep_or_index=10) | [`GetStudy`](#generated.RAProject.GetStudy)([study_name]) | Get the project's Study. | | [`GetTimeFilter`](#generated.RAProject.GetTimeFilter)() | Utility function to return the api object representing the project's time filter | | [`GetUserProcessCollection`](#generated.RAProject.GetUserProcessCollection)() | Get the project's collection of User Processes. | +| [`HasUnsavedChanges`](#generated.RAProject.HasUnsavedChanges)() | Check if the current project has unsaved changes. | | [`RemoveProcess`](#generated.RAProject.RemoveProcess)(process) | Removes the given process from the project. | | [`SaveProject`](#generated.RAProject.SaveProject)([filename]) | Save the currently opened project. | | [`SaveProjectForRestart`](#generated.RAProject.SaveProjectForRestart)(filename[, ...]) | Create a new restart project from the current project. | @@ -132,6 +133,15 @@ Utility function to return the api object representing the project’s time filt Get the project’s collection of User Processes. + + +#### HasUnsavedChanges() + +Check if the current project has unsaved changes. + +* **Returns:** + True if the project is modified (unsaved changes), False otherwise. + #### RemoveProcess(process: RAGridProcessElementItem | str) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAReceivingConveyor.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAReceivingConveyor.md index 1374f4a081..ee876ab865 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAReceivingConveyor.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAReceivingConveyor.md @@ -41,6 +41,7 @@ Rocky api Receiving Conveyor model. | [`GetBeltThickness`](#generated.RAReceivingConveyor.GetBeltThickness)([unit]) | Get the value of "Belt Thickness". | | [`GetBeltWidth`](#generated.RAReceivingConveyor.GetBeltWidth)([unit]) | Get the value of "Belt Width". | | [`GetBoundingBox`](#generated.RAReceivingConveyor.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCapillaryFrictionCoefficient`](#generated.RAReceivingConveyor.GetCapillaryFrictionCoefficient)() | Get the value of "Capillary Friction Coefficient". | | [`GetCellAreaAsArray`](#generated.RAReceivingConveyor.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | | [`GetCellCenterAsArray`](#generated.RAReceivingConveyor.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | | [`GetCellDzAsArray`](#generated.RAReceivingConveyor.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | @@ -54,10 +55,13 @@ Rocky api Receiving Conveyor model. | [`GetCurveNamesAssociation`](#generated.RAReceivingConveyor.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetDecelerationPeriod`](#generated.RAReceivingConveyor.GetDecelerationPeriod)([unit]) | Get the value of "Deceleration Period". | | [`GetElementCurve`](#generated.RAReceivingConveyor.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAReceivingConveyor.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAReceivingConveyor.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAReceivingConveyor.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAReceivingConveyor.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAReceivingConveyor.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAReceivingConveyor.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAReceivingConveyor.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAReceivingConveyor.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetHeightOffset`](#generated.RAReceivingConveyor.GetHeightOffset)([unit]) | Get the value of "Height Offset". | | [`GetHorizontalOffset`](#generated.RAReceivingConveyor.GetHorizontalOffset)([unit]) | Get the value of "Horizontal Offset". | | [`GetLength`](#generated.RAReceivingConveyor.GetLength)([unit]) | Get the value of "Length". | @@ -88,6 +92,7 @@ Rocky api Receiving Conveyor model. | [`GetValidSphBoundaryTypeValues`](#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues)() | Get a list of all possible values for "Sph Boundary Type". | | [`GetValidThermalBoundaryConditionTypeValues`](#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues)() | Get a list of all possible values for "Thermal Boundary Condition Type". | | [`GetVerticalOffset`](#generated.RAReceivingConveyor.GetVerticalOffset)([unit]) | Get the value of "Vertical Offset". | +| [`GetVertices`](#generated.RAReceivingConveyor.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetWidth`](#generated.RAReceivingConveyor.GetWidth)([unit]) | Get the value of "Width". | | [`HasGridFunction`](#generated.RAReceivingConveyor.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAReceivingConveyor.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -107,6 +112,7 @@ Rocky api Receiving Conveyor model. | [`SetBeltSpeed`](#generated.RAReceivingConveyor.SetBeltSpeed)(value[, unit]) | Set the value of "Belt Speed". | | [`SetBeltThickness`](#generated.RAReceivingConveyor.SetBeltThickness)(value[, unit]) | Set the value of "Belt Thickness". | | [`SetBeltWidth`](#generated.RAReceivingConveyor.SetBeltWidth)(value[, unit]) | Set the value of "Belt Width". | +| [`SetCapillaryFrictionCoefficient`](#generated.RAReceivingConveyor.SetCapillaryFrictionCoefficient)(value) | Set the value of "Capillary Friction Coefficient". | | [`SetCurrentTimeStep`](#generated.RAReceivingConveyor.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetDecelerationPeriod`](#generated.RAReceivingConveyor.SetDecelerationPeriod)(value[, unit]) | Set the value of "Deceleration Period". | | [`SetHeightOffset`](#generated.RAReceivingConveyor.SetHeightOffset)(value[, unit]) | Set the value of "Height Offset". | @@ -184,7 +190,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -196,7 +202,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -263,30 +269,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -488,16 +492,14 @@ Get the value of “Acceleration Period”. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -598,83 +600,79 @@ Get the value of “Belt Width”. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. + + +#### GetCapillaryFrictionCoefficient() + +Get the value of “Capillary Friction Coefficient”. + -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -683,39 +681,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -749,22 +743,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -815,25 +807,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -855,13 +887,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -869,22 +899,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -933,7 +950,7 @@ Get the “Material”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -974,31 +991,27 @@ Get the value of a module property. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1098,8 +1111,6 @@ Get “Thermal Boundary Condition Type” as a string. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1137,16 +1148,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1208,6 +1217,21 @@ Get the value of “Vertical Offset”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetWidth(unit: str | None = None) @@ -1219,44 +1243,40 @@ Get the value of “Width”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1266,12 +1286,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1411,6 +1431,15 @@ Set the value of “Belt Width”. * **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”. + + +#### SetCapillaryFrictionCoefficient(value: str | float) + +Set the value of “Capillary Friction Coefficient”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + #### SetCurrentTimeStep(time_step) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RARectangularSurface.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RARectangularSurface.md index 029d13d269..3c971f14f4 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RARectangularSurface.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RARectangularSurface.md @@ -43,12 +43,16 @@ Rocky API “Rectangular Surface” model. | [`GetCurveNames`](#generated.RARectangularSurface.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RARectangularSurface.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RARectangularSurface.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RARectangularSurface.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RARectangularSurface.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RARectangularSurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RARectangularSurface.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RARectangularSurface.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RARectangularSurface.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RARectangularSurface.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RARectangularSurface.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetLength`](#generated.RARectangularSurface.GetLength)([unit]) | Get the value of "Length". | | [`GetMeshColoring`](#generated.RARectangularSurface.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMotionFrame`](#generated.RARectangularSurface.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RARectangularSurface.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RARectangularSurface.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | | [`GetNumpyCurve`](#generated.RARectangularSurface.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | @@ -61,6 +65,7 @@ Rocky API “Rectangular Surface” model. | [`GetTimeStatistics`](#generated.RARectangularSurface.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RARectangularSurface.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RARectangularSurface.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RARectangularSurface.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetWidth`](#generated.RARectangularSurface.GetWidth)([unit]) | Get the value of "Width". | | [`HasGridFunction`](#generated.RARectangularSurface.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`HasMotionFrame`](#generated.RARectangularSurface.HasMotionFrame)() | Whether the geometry is linked to a motion frame. | @@ -75,6 +80,7 @@ Rocky API “Rectangular Surface” model. | [`SetCenter`](#generated.RARectangularSurface.SetCenter)(values[, unit]) | Set the values of "Center". | | [`SetCurrentTimeStep`](#generated.RARectangularSurface.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetLength`](#generated.RARectangularSurface.SetLength)(value[, unit]) | Set the value of "Length". | +| [`SetMotionFrame`](#generated.RARectangularSurface.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | | [`SetOrientation`](#generated.RARectangularSurface.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | | [`SetOrientationFromAngleAndVector`](#generated.RARectangularSurface.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | | [`SetOrientationFromAngles`](#generated.RARectangularSurface.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | @@ -138,7 +144,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -150,7 +156,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -217,30 +223,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -433,99 +437,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -534,39 +526,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -600,16 +588,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -624,7 +610,7 @@ Get the value of “Center”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -666,25 +652,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -706,13 +732,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -720,22 +744,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -748,7 +759,7 @@ Get the value of “Length”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -759,33 +770,36 @@ Get the RAMeshColoring related to the current object and a window. **RockyApiError** – If window is not a str or KAWorkspaceWindow. Additionally, raises an error if no window is found or no coloring for the given item exists. + + +#### GetMotionFrame() + +* **Returns:** + The motion frame set in the process, or None if no motion is set. + -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -838,8 +852,6 @@ Get the value of a previously-created output variable. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -877,19 +889,32 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetWidth(unit: str | None = None) @@ -901,14 +926,12 @@ Get the value of “Width”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -923,31 +946,29 @@ Whether the geometry is linked to a motion frame. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -957,12 +978,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1041,6 +1062,15 @@ Set the value of “Length”. * **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”. + + +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) + +Assign a Motion Frame to the process. + +* **Parameters:** + **motion_frame** – Either the API object or its name. + #### SetOrientation(rotation: tuple[float, float, float], unit: str = 'dega') diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCube.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCube.md index e11e46e205..4e9afff915 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCube.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCube.md @@ -52,10 +52,13 @@ roi_cube_1 = study.GetElement('Cube <1>') | [`GetCurveNames`](#generated.RARegionOfInterestCube.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RARegionOfInterestCube.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RARegionOfInterestCube.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RARegionOfInterestCube.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RARegionOfInterestCube.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RARegionOfInterestCube.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RARegionOfInterestCube.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RARegionOfInterestCube.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RARegionOfInterestCube.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RARegionOfInterestCube.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RARegionOfInterestCube.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RARegionOfInterestCube.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMotionFrame`](#generated.RARegionOfInterestCube.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RARegionOfInterestCube.GetNumberOfCells)([time_step]) | Get the total number of cells. | @@ -71,6 +74,7 @@ roi_cube_1 = study.GetElement('Cube <1>') | [`GetTimeStatistics`](#generated.RARegionOfInterestCube.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RARegionOfInterestCube.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RARegionOfInterestCube.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RARegionOfInterestCube.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RARegionOfInterestCube.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RARegionOfInterestCube.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RARegionOfInterestCube.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -146,7 +150,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -158,7 +162,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -225,30 +229,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -441,99 +443,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -542,39 +532,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -608,16 +594,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -638,7 +622,7 @@ Get the Region of Interest center taking motion in account. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -680,25 +664,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -720,13 +744,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -734,26 +756,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -773,31 +782,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -859,8 +864,6 @@ Get the value of “Size”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -898,59 +901,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -960,12 +972,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1036,7 +1048,7 @@ Sets the current time step. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCylinder.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCylinder.md index 65932c2a5a..d064e92386 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCylinder.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RARegionOfInterestCylinder.md @@ -52,11 +52,14 @@ roi_cylinder = study.GetElement('Cylinder <1>') | [`GetCurveNames`](#generated.RARegionOfInterestCylinder.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RARegionOfInterestCylinder.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RARegionOfInterestCylinder.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RARegionOfInterestCylinder.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFinalAngle`](#generated.RARegionOfInterestCylinder.GetFinalAngle)([unit]) | Get the value of "Final Angle". | | [`GetGeometryQuantity`](#generated.RARegionOfInterestCylinder.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RARegionOfInterestCylinder.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RARegionOfInterestCylinder.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RARegionOfInterestCylinder.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RARegionOfInterestCylinder.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RARegionOfInterestCylinder.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetHeight`](#generated.RARegionOfInterestCylinder.GetHeight)([unit]) | Get the value of "Height". | | [`GetInitialAngle`](#generated.RARegionOfInterestCylinder.GetInitialAngle)([unit]) | Get the value of "Initial Angle". | | [`GetInternalFactor`](#generated.RARegionOfInterestCylinder.GetInternalFactor)([unit]) | Get the value of "Internal Factor". | @@ -75,6 +78,7 @@ roi_cylinder = study.GetElement('Cylinder <1>') | [`GetTimeStatistics`](#generated.RARegionOfInterestCylinder.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RARegionOfInterestCylinder.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RARegionOfInterestCylinder.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RARegionOfInterestCylinder.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RARegionOfInterestCylinder.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RARegionOfInterestCylinder.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RARegionOfInterestCylinder.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -154,7 +158,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -166,7 +170,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -233,30 +237,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -449,99 +451,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -550,39 +540,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -616,16 +602,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -646,7 +630,7 @@ Get the Region of Interest center taking motion in account. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -688,6 +672,35 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFinalAngle(unit: str | None = None) @@ -703,19 +716,30 @@ Get the value of “Final Angle”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -737,13 +761,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -751,22 +773,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -797,7 +806,7 @@ Get the value of “Internal Factor”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -817,31 +826,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -903,8 +908,6 @@ Get the value of “Radius”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -942,59 +945,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1004,12 +1016,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1120,7 +1132,7 @@ Set the value of “Internal Factor”. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHEulerianSolution.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHEulerianSolution.md index 7bd0155d4b..9e25e123d6 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHEulerianSolution.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHEulerianSolution.md @@ -51,7 +51,7 @@ Delegates the method to the project sph settings. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHSettings.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHSettings.md index a75c59d5d2..bdcb8463dd 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHSettings.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RASPHSettings.md @@ -24,167 +24,187 @@ sph_settings = study.GetElement('SPH') **Methods:** | Name | Description | -|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`AddCurve`](#generated.RASPHSettings.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | -| [`AddCustomCurve`](#generated.RASPHSettings.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`AddCustomProperty`](#generated.RASPHSettings.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | -| [`AddGridFunction`](#generated.RASPHSettings.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | -| [`CreateCurveOutputVariable`](#generated.RASPHSettings.CreateCurveOutputVariable)(curve_name[, ...]) | Used to create an output variable based on a curve which doesn't change at each new timestep (i.e.: a curve with a single value for each time). | -| [`CreateGridFunction`](#generated.RASPHSettings.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | -| [`CreateGridFunctionArrayOnCells`](#generated.RASPHSettings.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | -| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable)(...) | Used to create an output variable based on a grid function statistic (i.e.: will get a grid function, compute its statistic based on statistic_operation and then based on the statistic values will apply the operation to get a single scalar). | -| [`CreateTransientCurveOutputVariable`](#generated.RASPHSettings.CreateTransientCurveOutputVariable)(curve_name) | Used to create an output variable based on a curve for which there's a completely new representation for each time step -- such as Power : Impact X Belt Width (i.e.: will get the curve multiple times based on the time range, compute a value for each time based on the operation, to convert the multiple curves into a single curve and then will apply the time_operation to get a single scalar from those values). | -| [`DisableEulerianSolution`](#generated.RASPHSettings.DisableEulerianSolution)() | Set the value of "Eulerian Solution" to False. | -| [`DisableShepardFilterOnDensity`](#generated.RASPHSettings.DisableShepardFilterOnDensity)() | Set the value of "Shepard Filter On Density" to False. | -| [`DisableShepardFilterOnPressure`](#generated.RASPHSettings.DisableShepardFilterOnPressure)() | Set the value of "Shepard Filter On Pressure" to False. | -| [`EditCustomCurve`](#generated.RASPHSettings.EditCustomCurve)(edit_curve[, new_name, ...]) | Edit a custom curve saved in the database. :param edit_curve: The name of the curve to be edited. :param new_name: The new name of the curve to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`EditCustomProperty`](#generated.RASPHSettings.EditCustomProperty)(edit_property[, ...]) | Edit a custom property saved in the database. :param edit_property: The name of the property to be edited. :param new_name: The new name of the property to be set. :param sources: A dict pointing the variable used to the property association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | -| [`EnableEulerianSolution`](#generated.RASPHSettings.EnableEulerianSolution)() | Set the value of "Eulerian Solution" to True. | -| [`EnableShepardFilterOnDensity`](#generated.RASPHSettings.EnableShepardFilterOnDensity)() | Set the value of "Shepard Filter On Density" to True. | -| [`EnableShepardFilterOnPressure`](#generated.RASPHSettings.EnableShepardFilterOnPressure)() | Set the value of "Shepard Filter On Pressure" to True. | -| [`GetActivesArray`](#generated.RASPHSettings.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | -| [`GetAvailableFluidMaterials`](#generated.RASPHSettings.GetAvailableFluidMaterials)() | Get all available Fluid Materials. | -| [`GetBackgroundPressure`](#generated.RASPHSettings.GetBackgroundPressure)() | The Background Pressure parameter was removed from Rocky since 24R1. | -| [`GetBoundingBox`](#generated.RASPHSettings.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | -| [`GetCS`](#generated.RASPHSettings.GetCS)() | Get the value of "C S". | -| [`GetCellAreaAsArray`](#generated.RASPHSettings.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | -| [`GetCellCenterAsArray`](#generated.RASPHSettings.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | -| [`GetCellDzAsArray`](#generated.RASPHSettings.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | -| [`GetCellFromIJK`](#generated.RASPHSettings.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | -| [`GetCellIJK`](#generated.RASPHSettings.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | -| [`GetCellNumberOfVertices`](#generated.RASPHSettings.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | -| [`GetCellPointsAsFunction`](#generated.RASPHSettings.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | -| [`GetCellVolumeAsArray`](#generated.RASPHSettings.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetClearyFactor`](#generated.RASPHSettings.GetClearyFactor)() | Get the value of "Cleary Factor". | -| [`GetCurve`](#generated.RASPHSettings.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | -| [`GetCurveNames`](#generated.RASPHSettings.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | -| [`GetCurveNamesAssociation`](#generated.RASPHSettings.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | -| [`GetDensityDevMinus`](#generated.RASPHSettings.GetDensityDevMinus)() | Get the value of "Density Dev Minus". | -| [`GetDensityDevPlus`](#generated.RASPHSettings.GetDensityDevPlus)() | Get the value of "Density Dev Plus". | -| [`GetDensityRelativeErrorTolerance`](#generated.RASPHSettings.GetDensityRelativeErrorTolerance)() | Get the value of "Density Relative Error Tolerance". | -| [`GetDissFactor`](#generated.RASPHSettings.GetDissFactor)() | Get the value of "Diss Factor". | -| [`GetDistFactorNorm`](#generated.RASPHSettings.GetDistFactorNorm)() | Get the value of "Dist Factor Norm". | -| [`GetDistFactorTang`](#generated.RASPHSettings.GetDistFactorTang)() | Get the value of "Dist Factor Tang". | -| [`GetElementCurve`](#generated.RASPHSettings.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | -| [`GetEulerianSolutionEnabled`](#generated.RASPHSettings.GetEulerianSolutionEnabled)() | Get the value of "Eulerian Solution Enabled". | -| [`GetFluidMaterial`](#generated.RASPHSettings.GetFluidMaterial)() | Get the "Fluid Material". | -| [`GetFreeSurfaceDivergenceLimit`](#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit)() | Get the value of "Free Surface Divergence Limit". | -| [`GetGeometryQuantity`](#generated.RASPHSettings.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | -| [`GetGeometryUnit`](#generated.RASPHSettings.GetGeometryUnit)() | Get the grid's geometry's unit. | -| [`GetGridFunction`](#generated.RASPHSettings.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RASPHSettings.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | -| [`GetKernelDistFactor`](#generated.RASPHSettings.GetKernelDistFactor)() | Get the value of "Kernel Dist Factor". | -| [`GetKernelType`](#generated.RASPHSettings.GetKernelType)() | Get "Kernel Type" as a string. | -| [`GetLimitTurbulentViscosity`](#generated.RASPHSettings.GetLimitTurbulentViscosity)() | Get the value of "Limit Turbulent Viscosity". | -| [`GetMaximumExpectedVelocity`](#generated.RASPHSettings.GetMaximumExpectedVelocity)([unit]) | Get the value of "Maximum Expected Velocity". | -| [`GetMaximumNumberOfIterations`](#generated.RASPHSettings.GetMaximumNumberOfIterations)() | Get the value of "Maximum Number of Iterations". | -| [`GetMeshColoring`](#generated.RASPHSettings.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | -| [`GetMinDistFactor`](#generated.RASPHSettings.GetMinDistFactor)() | Get the value of "Min Dist Factor". | -| [`GetNegativePressureFactor`](#generated.RASPHSettings.GetNegativePressureFactor)() | Get the value of "Negative Pressure Factor". | -| [`GetNumCellSteps`](#generated.RASPHSettings.GetNumCellSteps)() | Get the value of "Num Cell Steps". | -| [`GetNumberOfCells`](#generated.RASPHSettings.GetNumberOfCells)([time_step]) | Get the total number of cells. | -| [`GetNumberOfNodes`](#generated.RASPHSettings.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | -| [`GetNumberOfSteps`](#generated.RASPHSettings.GetNumberOfSteps)() | Get the value of "Number of Steps". | -| [`GetNumpyCurve`](#generated.RASPHSettings.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | -| [`GetOutputVariableValue`](#generated.RASPHSettings.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | -| [`GetPosCorrectionType`](#generated.RASPHSettings.GetPosCorrectionType)() | Get "Pos Correction Type" as a string. | -| [`GetPressureDeg`](#generated.RASPHSettings.GetPressureDeg)() | Get the value of "Pressure Deg". | -| [`GetPressureUnderRelaxationFactor`](#generated.RASPHSettings.GetPressureUnderRelaxationFactor)() | Get the value of "Pressure Under Relaxation Factor". | -| [`GetShepardFilterOnDensityEnabled`](#generated.RASPHSettings.GetShepardFilterOnDensityEnabled)() | Get the value of "Shepard Filter On Density Enabled". | -| [`GetShepardFilterOnPressureEnabled`](#generated.RASPHSettings.GetShepardFilterOnPressureEnabled)() | Get the value of "Shepard Filter On Pressure Enabled". | -| [`GetShiftingFactor`](#generated.RASPHSettings.GetShiftingFactor)() | Get the value of "Shifting Factor". | -| [`GetSize`](#generated.RASPHSettings.GetSize)([unit]) | Get the value of "Size". | -| [`GetSolver`](#generated.RASPHSettings.GetSolver)() | Get "Solver Model" as a string. | -| [`GetSolverModel`](#generated.RASPHSettings.GetSolverModel)() | Get "Solver Model" as a string. | -| [`GetSoundSpeed`](#generated.RASPHSettings.GetSoundSpeed)([unit]) | Get the value of "Sound Speed". | -| [`GetStabilityDegree`](#generated.RASPHSettings.GetStabilityDegree)() | Get the value of "Stability Degree". | -| [`GetStabilityNegFactor`](#generated.RASPHSettings.GetStabilityNegFactor)() | Get the value of "Stability Neg Factor". | -| [`GetStabilityPosFactor`](#generated.RASPHSettings.GetStabilityPosFactor)() | Get the value of "Stability Pos Factor". | -| [`GetStiffFactor`](#generated.RASPHSettings.GetStiffFactor)() | Get the value of "Stiff Factor". | -| [`GetSurfaceTensionBoundaryAngle`](#generated.RASPHSettings.GetSurfaceTensionBoundaryAngle)([unit]) | Get the value of "Surface Tension Boundary Angle". | -| [`GetSurfaceTensionBoundaryFraction`](#generated.RASPHSettings.GetSurfaceTensionBoundaryFraction)() | Get the value of "Surface Tension Boundary Fraction". | -| [`GetSurfaceTensionCoefficient`](#generated.RASPHSettings.GetSurfaceTensionCoefficient)([unit]) | Get the value of "Surface Tension Coefficient". | -| [`GetSurfaceTensionType`](#generated.RASPHSettings.GetSurfaceTensionType)() | Get "Surface Tension Type" as a string. | -| [`GetTimeSet`](#generated.RASPHSettings.GetTimeSet)() | Get the list of time-steps associated to the grid. | -| [`GetTimeStatistics`](#generated.RASPHSettings.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | -| [`GetTimeStep`](#generated.RASPHSettings.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | -| [`GetTimestepFactor`](#generated.RASPHSettings.GetTimestepFactor)() | Get the value of "Timestep Factor". | -| [`GetTopologyShape`](#generated.RASPHSettings.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | -| [`GetTurbDistanceFraction`](#generated.RASPHSettings.GetTurbDistanceFraction)() | Get the value of "Turb Distance Fraction". | -| [`GetTurbulenceType`](#generated.RASPHSettings.GetTurbulenceType)() | Get "Turbulence Type" as a string. | -| [`GetTurbulentPrandtl`](#generated.RASPHSettings.GetTurbulentPrandtl)() | Get the value of "Turbulent Prandtl". | -| [`GetTurbulentViscosityMaximumRatio`](#generated.RASPHSettings.GetTurbulentViscosityMaximumRatio)() | Get the value of "Turbulent Viscosity Maximum Ratio". | -| [`GetUpdateCoupledDensity`](#generated.RASPHSettings.GetUpdateCoupledDensity)() | Get the value of "Update Coupled Density". | -| [`GetUseParticlesNeighborsList`](#generated.RASPHSettings.GetUseParticlesNeighborsList)() | Get the value of "Use Particles Neighbors List". | -| [`GetValidKernelTypeValues`](#generated.RASPHSettings.GetValidKernelTypeValues)() | Get a list of all possible values for "Kernel Type". | -| [`GetValidPosCorrectionTypeValues`](#generated.RASPHSettings.GetValidPosCorrectionTypeValues)() | Get a list of all possible values for "Pos Correction Type". | -| [`GetValidSolverModelValues`](#generated.RASPHSettings.GetValidSolverModelValues)() | Get a list of all possible values for "Solver Model". | -| [`GetValidSurfaceTensionTypeValues`](#generated.RASPHSettings.GetValidSurfaceTensionTypeValues)() | Get a list of all possible values for "Surface Tension Type". | -| [`GetValidTurbulenceTypeValues`](#generated.RASPHSettings.GetValidTurbulenceTypeValues)() | Get a list of all possible values for "Turbulence Type". | -| [`GetValidViscosityTypeValues`](#generated.RASPHSettings.GetValidViscosityTypeValues)() | Get a list of all possible values for "Viscosity Type". | -| [`GetViscosityType`](#generated.RASPHSettings.GetViscosityType)() | Get "Viscosity Type" as a string. | -| [`GetXsphFactor`](#generated.RASPHSettings.GetXsphFactor)() | Get the value of "Xsph Factor". | -| [`HasGridFunction`](#generated.RASPHSettings.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | -| [`IsCellActive`](#generated.RASPHSettings.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | -| [`IsEulerianSolutionEnabled`](#generated.RASPHSettings.IsEulerianSolutionEnabled)() | Check if the "Eulerian Solution" is enabled. | -| [`IsShepardFilterOnDensityEnabled`](#generated.RASPHSettings.IsShepardFilterOnDensityEnabled)() | Check if the "Shepard Filter On Density" is enabled. | -| [`IsShepardFilterOnPressureEnabled`](#generated.RASPHSettings.IsShepardFilterOnPressureEnabled)() | Check if the "Shepard Filter On Pressure" is enabled. | -| [`IterCellVertices`](#generated.RASPHSettings.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | -| [`IterCells`](#generated.RASPHSettings.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | -| [`Modified`](#generated.RASPHSettings.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | -| [`RemoveCustomCurve`](#generated.RASPHSettings.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | -| [`RemoveCustomProperty`](#generated.RASPHSettings.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | -| [`RemoveOutputVariable`](#generated.RASPHSettings.RemoveOutputVariable)(variable_name) | Removes some output variable. | -| [`RemoveProcess`](#generated.RASPHSettings.RemoveProcess)() | Removes the process from the project. | -| [`SetBackgroundPressure`](#generated.RASPHSettings.SetBackgroundPressure)(value[, unit]) | The Background Pressure parameter was removed from Rocky since 24R1. | -| [`SetCS`](#generated.RASPHSettings.SetCS)(value) | Set the value of "C S". | -| [`SetClearyFactor`](#generated.RASPHSettings.SetClearyFactor)(value) | Set the value of "Cleary Factor". | -| [`SetCurrentTimeStep`](#generated.RASPHSettings.SetCurrentTimeStep)(time_step) | Sets the current time step. | -| [`SetDensityDevMinus`](#generated.RASPHSettings.SetDensityDevMinus)(value) | Set the value of "Density Dev Minus". | -| [`SetDensityDevPlus`](#generated.RASPHSettings.SetDensityDevPlus)(value) | Set the value of "Density Dev Plus". | -| [`SetDensityRelativeErrorTolerance`](#generated.RASPHSettings.SetDensityRelativeErrorTolerance)(value) | Set the value of "Density Relative Error Tolerance". | -| [`SetDissFactor`](#generated.RASPHSettings.SetDissFactor)(value) | Set the value of "Diss Factor". | -| [`SetDistFactorNorm`](#generated.RASPHSettings.SetDistFactorNorm)(value) | Set the value of "Dist Factor Norm". | -| [`SetDistFactorTang`](#generated.RASPHSettings.SetDistFactorTang)(value) | Set the value of "Dist Factor Tang". | -| [`SetEulerianSolutionEnabled`](#generated.RASPHSettings.SetEulerianSolutionEnabled)(value) | Set the value of "Eulerian Solution Enabled". | -| [`SetFluidMaterial`](#generated.RASPHSettings.SetFluidMaterial)(value) | Set the "Fluid Material". | -| [`SetFreeSurfaceDivergenceLimit`](#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit)(value) | Set the value of "Free Surface Divergence Limit". | -| [`SetKernelDistFactor`](#generated.RASPHSettings.SetKernelDistFactor)(value) | Set the value of "Kernel Dist Factor". | -| [`SetKernelType`](#generated.RASPHSettings.SetKernelType)(value) | Set the value of "Kernel Type". | -| [`SetLimitTurbulentViscosity`](#generated.RASPHSettings.SetLimitTurbulentViscosity)(value) | Set the value of "Limit Turbulent Viscosity". | -| [`SetMaximumExpectedVelocity`](#generated.RASPHSettings.SetMaximumExpectedVelocity)(value[, unit]) | Set the value of "Maximum Expected Velocity". | -| [`SetMaximumNumberOfIterations`](#generated.RASPHSettings.SetMaximumNumberOfIterations)(value) | Set the value of "Maximum Number of Iterations". | -| [`SetMinDistFactor`](#generated.RASPHSettings.SetMinDistFactor)(value) | Set the value of "Min Dist Factor". | -| [`SetNegativePressureFactor`](#generated.RASPHSettings.SetNegativePressureFactor)(value) | Set the value of "Negative Pressure Factor". | -| [`SetNumCellSteps`](#generated.RASPHSettings.SetNumCellSteps)(value) | Set the value of "Num Cell Steps". | -| [`SetNumberOfSteps`](#generated.RASPHSettings.SetNumberOfSteps)(value) | Set the value of "Number of Steps". | -| [`SetPosCorrectionType`](#generated.RASPHSettings.SetPosCorrectionType)(value) | Set the value of "Pos Correction Type". | -| [`SetPressureDeg`](#generated.RASPHSettings.SetPressureDeg)(value) | Set the value of "Pressure Deg". | -| [`SetPressureUnderRelaxationFactor`](#generated.RASPHSettings.SetPressureUnderRelaxationFactor)(value) | Set the value of "Pressure Under Relaxation Factor". | -| [`SetShepardFilterOnDensityEnabled`](#generated.RASPHSettings.SetShepardFilterOnDensityEnabled)(value) | Set the value of "Shepard Filter On Density Enabled". | -| [`SetShepardFilterOnPressureEnabled`](#generated.RASPHSettings.SetShepardFilterOnPressureEnabled)(value) | Set the value of "Shepard Filter On Pressure Enabled". | -| [`SetShiftingFactor`](#generated.RASPHSettings.SetShiftingFactor)(value) | Set the value of "Shifting Factor". | -| [`SetSize`](#generated.RASPHSettings.SetSize)(value[, unit]) | Set the value of "Size". | -| [`SetSolver`](#generated.RASPHSettings.SetSolver)(value) | Set the value of "Solver Model". | -| [`SetSolverModel`](#generated.RASPHSettings.SetSolverModel)(value) | Set the value of "Solver Model". | -| [`SetSoundSpeed`](#generated.RASPHSettings.SetSoundSpeed)(value[, unit]) | Set the value of "Sound Speed". | -| [`SetStabilityDegree`](#generated.RASPHSettings.SetStabilityDegree)(value) | Set the value of "Stability Degree". | -| [`SetStabilityNegFactor`](#generated.RASPHSettings.SetStabilityNegFactor)(value) | Set the value of "Stability Neg Factor". | -| [`SetStabilityPosFactor`](#generated.RASPHSettings.SetStabilityPosFactor)(value) | Set the value of "Stability Pos Factor". | -| [`SetStiffFactor`](#generated.RASPHSettings.SetStiffFactor)(value) | Set the value of "Stiff Factor". | -| [`SetSurfaceTensionBoundaryAngle`](#generated.RASPHSettings.SetSurfaceTensionBoundaryAngle)(value[, unit]) | Set the value of "Surface Tension Boundary Angle". | -| [`SetSurfaceTensionBoundaryFraction`](#generated.RASPHSettings.SetSurfaceTensionBoundaryFraction)(value) | Set the value of "Surface Tension Boundary Fraction". | -| [`SetSurfaceTensionCoefficient`](#generated.RASPHSettings.SetSurfaceTensionCoefficient)(value[, unit]) | Set the value of "Surface Tension Coefficient". | -| [`SetSurfaceTensionType`](#generated.RASPHSettings.SetSurfaceTensionType)(value) | Set the value of "Surface Tension Type". | -| [`SetTimestepFactor`](#generated.RASPHSettings.SetTimestepFactor)(value) | Set the value of "Timestep Factor". | -| [`SetTurbDistanceFraction`](#generated.RASPHSettings.SetTurbDistanceFraction)(value) | Set the value of "Turb Distance Fraction". | -| [`SetTurbulenceType`](#generated.RASPHSettings.SetTurbulenceType)(value) | Set the value of "Turbulence Type". | -| [`SetTurbulentPrandtl`](#generated.RASPHSettings.SetTurbulentPrandtl)(value) | Set the value of "Turbulent Prandtl". | -| [`SetTurbulentViscosityMaximumRatio`](#generated.RASPHSettings.SetTurbulentViscosityMaximumRatio)(value) | Set the value of "Turbulent Viscosity Maximum Ratio". | -| [`SetUpdateCoupledDensity`](#generated.RASPHSettings.SetUpdateCoupledDensity)(value) | Set the value of "Update Coupled Density". | -| [`SetUseParticlesNeighborsList`](#generated.RASPHSettings.SetUseParticlesNeighborsList)(value) | Set the value of "Use Particles Neighbors List". | -| [`SetViscosityType`](#generated.RASPHSettings.SetViscosityType)(value) | Set the value of "Viscosity Type". | -| [`SetXsphFactor`](#generated.RASPHSettings.SetXsphFactor)(value) | Set the value of "Xsph Factor". | +|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`AddCurve`](#generated.RASPHSettings.AddCurve)(curve_name, timesteps, values, unit) | Add a curve to the element with a time-steps domain | +| [`AddCustomCurve`](#generated.RASPHSettings.AddCustomCurve)(name[, curve_type, ...]) | Add a custom curve in the database. :param name: The name of the curve to be set. :param curve_type: The type of the custom curve to be added. :param output_unit: The output unit, in which case the unit database will be queried for a quantity that makes sense. If None, the quantity is considered unknown. :param scope: The scope to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | +| [`AddCustomProperty`](#generated.RASPHSettings.AddCustomProperty)(name[, property_type, ...]) | Add a custom property to the database | +| [`AddGridFunction`](#generated.RASPHSettings.AddGridFunction)(grid_function_name, ...[, ...]) | Adds a grid function to the grid. | +| [`CreateCurveOutputVariable`](#generated.RASPHSettings.CreateCurveOutputVariable)(curve_name[, ...]) | Used to create an output variable based on a curve which doesn't change at each new timestep (i.e.: a curve with a single value for each time). | +| [`CreateGridFunction`](#generated.RASPHSettings.CreateGridFunction)(values[, location, time_step]) | Create a grid function from the given values, location and time-step. | +| [`CreateGridFunctionArrayOnCells`](#generated.RASPHSettings.CreateGridFunctionArrayOnCells)([time_step]) | Creates a numpy array with the number of elements based on the cells and returns it. | +| [`CreateGridFunctionStatisticOutputVariable`](#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable)(...) | Used to create an output variable based on a grid function statistic (i.e.: will get a grid function, compute its statistic based on statistic_operation and then based on the statistic values will apply the operation to get a single scalar). | +| [`CreateTransientCurveOutputVariable`](#generated.RASPHSettings.CreateTransientCurveOutputVariable)(curve_name) | Used to create an output variable based on a curve for which there's a completely new representation for each time step -- such as Power : Impact X Belt Width (i.e.: will get the curve multiple times based on the time range, compute a value for each time based on the operation, to convert the multiple curves into a single curve and then will apply the time_operation to get a single scalar from those values). | +| [`DisableEulerianSolution`](#generated.RASPHSettings.DisableEulerianSolution)() | Set the value of "Eulerian Solution" to False. | +| [`DisableRelaxedIncompressibilityConstraint`](#generated.RASPHSettings.DisableRelaxedIncompressibilityConstraint)() | Set the value of "Relaxed Incompressibility Constraint" to False. | +| [`DisableShepardFilterOnDensity`](#generated.RASPHSettings.DisableShepardFilterOnDensity)() | Set the value of "Shepard Filter On Density" to False. | +| [`DisableShepardFilterOnPressure`](#generated.RASPHSettings.DisableShepardFilterOnPressure)() | Set the value of "Shepard Filter On Pressure" to False. | +| [`EditCustomCurve`](#generated.RASPHSettings.EditCustomCurve)(edit_curve[, new_name, ...]) | Edit a custom curve saved in the database. :param edit_curve: The name of the curve to be edited. :param new_name: The new name of the curve to be set. :param sources: A dict pointing the variable used to the curve association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | +| [`EditCustomProperty`](#generated.RASPHSettings.EditCustomProperty)(edit_property[, ...]) | Edit a custom property saved in the database. :param edit_property: The name of the property to be edited. :param new_name: The new name of the property to be set. :param sources: A dict pointing the variable used to the property association it represents and a string indicating in which unit the input data should be gotten. :param expression: The expression to be set. | +| [`EnableEulerianSolution`](#generated.RASPHSettings.EnableEulerianSolution)() | Set the value of "Eulerian Solution" to True. | +| [`EnableRelaxedIncompressibilityConstraint`](#generated.RASPHSettings.EnableRelaxedIncompressibilityConstraint)() | Set the value of "Relaxed Incompressibility Constraint" to True. | +| [`EnableShepardFilterOnDensity`](#generated.RASPHSettings.EnableShepardFilterOnDensity)() | Set the value of "Shepard Filter On Density" to True. | +| [`EnableShepardFilterOnPressure`](#generated.RASPHSettings.EnableShepardFilterOnPressure)() | Set the value of "Shepard Filter On Pressure" to True. | +| [`GetActivesArray`](#generated.RASPHSettings.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | +| [`GetAvailableFluidMaterials`](#generated.RASPHSettings.GetAvailableFluidMaterials)() | Get all available Fluid Materials. | +| [`GetBoundingBox`](#generated.RASPHSettings.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCS`](#generated.RASPHSettings.GetCS)() | Get the value of "C S". | +| [`GetCellAreaAsArray`](#generated.RASPHSettings.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | +| [`GetCellCenterAsArray`](#generated.RASPHSettings.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | +| [`GetCellDzAsArray`](#generated.RASPHSettings.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | +| [`GetCellFromIJK`](#generated.RASPHSettings.GetCellFromIJK)(i, j, k[, time_step]) | Creates a grid cell handle from the current I, J, K indexes | +| [`GetCellIJK`](#generated.RASPHSettings.GetCellIJK)(cell_handle[, time_step]) | Converts the given cell handle to it's I, J, K indexes | +| [`GetCellNumberOfVertices`](#generated.RASPHSettings.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | +| [`GetCellPointsAsFunction`](#generated.RASPHSettings.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | +| [`GetCellVolumeAsArray`](#generated.RASPHSettings.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | +| [`GetClearyFactor`](#generated.RASPHSettings.GetClearyFactor)() | Get the value of "Cleary Factor". | +| [`GetCurve`](#generated.RASPHSettings.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | +| [`GetCurveNames`](#generated.RASPHSettings.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | +| [`GetCurveNamesAssociation`](#generated.RASPHSettings.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | +| [`GetDensityDevMinus`](#generated.RASPHSettings.GetDensityDevMinus)() | Get the value of "Density Dev Minus". | +| [`GetDensityDevPlus`](#generated.RASPHSettings.GetDensityDevPlus)() | Get the value of "Density Dev Plus". | +| [`GetDensityRelativeErrorTolerance`](#generated.RASPHSettings.GetDensityRelativeErrorTolerance)() | Get the value of "Density Relative Error Tolerance". | +| [`GetDissFactor`](#generated.RASPHSettings.GetDissFactor)() | Get the value of "Diss Factor". | +| [`GetDistFactorNorm`](#generated.RASPHSettings.GetDistFactorNorm)() | Get the value of "Dist Factor Norm". | +| [`GetDistFactorTang`](#generated.RASPHSettings.GetDistFactorTang)() | Get the value of "Dist Factor Tang". | +| [`GetElementCurve`](#generated.RASPHSettings.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetEnabled`](#generated.RASPHSettings.GetEnabled)() | Get the value of "Enabled". | +| [`GetEulerianSolutionEnabled`](#generated.RASPHSettings.GetEulerianSolutionEnabled)() | Get the value of "Eulerian Solution Enabled". | +| [`GetFacePositions`](#generated.RASPHSettings.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RASPHSettings.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | +| [`GetFluidMaterial`](#generated.RASPHSettings.GetFluidMaterial)() | Get the "Fluid Material". | +| [`GetFreeSurfaceDivergenceLimit`](#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit)() | Get the value of "Free Surface Divergence Limit". | +| [`GetGeometryQuantity`](#generated.RASPHSettings.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RASPHSettings.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | +| [`GetGeometryUnit`](#generated.RASPHSettings.GetGeometryUnit)() | Get the grid's geometry's unit. | +| [`GetGridFunction`](#generated.RASPHSettings.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | +| [`GetGridFunctionNames`](#generated.RASPHSettings.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | +| [`GetIncompressibilityRelaxationFactor`](#generated.RASPHSettings.GetIncompressibilityRelaxationFactor)() | Get the value of "Incompressibility Relaxation Factor". | +| [`GetKernelDistFactor`](#generated.RASPHSettings.GetKernelDistFactor)() | Get the value of "Kernel Dist Factor". | +| [`GetKernelType`](#generated.RASPHSettings.GetKernelType)() | Get "Kernel Type" as a string. | +| [`GetLimitTurbulentViscosity`](#generated.RASPHSettings.GetLimitTurbulentViscosity)() | Get the value of "Limit Turbulent Viscosity". | +| [`GetMaximumExpectedVelocity`](#generated.RASPHSettings.GetMaximumExpectedVelocity)([unit]) | Get the value of "Maximum Expected Velocity". | +| [`GetMaximumNumberOfIterations`](#generated.RASPHSettings.GetMaximumNumberOfIterations)() | Get the value of "Maximum Number of Iterations". | +| [`GetMeshColoring`](#generated.RASPHSettings.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMinDistFactor`](#generated.RASPHSettings.GetMinDistFactor)() | Get the value of "Min Dist Factor". | +| [`GetNegativePressureFactor`](#generated.RASPHSettings.GetNegativePressureFactor)() | Get the value of "Negative Pressure Factor". | +| [`GetNumCellSteps`](#generated.RASPHSettings.GetNumCellSteps)() | Get the value of "Num Cell Steps". | +| [`GetNumberOfCells`](#generated.RASPHSettings.GetNumberOfCells)([time_step]) | Get the total number of cells. | +| [`GetNumberOfNodes`](#generated.RASPHSettings.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | +| [`GetNumberOfSteps`](#generated.RASPHSettings.GetNumberOfSteps)() | Get the value of "Number of Steps". | +| [`GetNumpyCurve`](#generated.RASPHSettings.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | +| [`GetOutputVariableValue`](#generated.RASPHSettings.GetOutputVariableValue)(variable_name) | Get the value of a previously-created output variable. | +| [`GetPosCorrectionType`](#generated.RASPHSettings.GetPosCorrectionType)() | Get "Pos Correction Type" as a string. | +| [`GetPressureDeg`](#generated.RASPHSettings.GetPressureDeg)() | Get the value of "Pressure Deg". | +| [`GetPressureUnderRelaxationFactor`](#generated.RASPHSettings.GetPressureUnderRelaxationFactor)() | Get the value of "Pressure Under Relaxation Factor". | +| [`GetRelaxedIncompressibilityConstraintEnabled`](#generated.RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled)() | Get the value of "Relaxed Incompressibility Constraint Enabled". | +| [`GetShepardFilterOnDensityEnabled`](#generated.RASPHSettings.GetShepardFilterOnDensityEnabled)() | Get the value of "Shepard Filter On Density Enabled". | +| [`GetShepardFilterOnPressureEnabled`](#generated.RASPHSettings.GetShepardFilterOnPressureEnabled)() | Get the value of "Shepard Filter On Pressure Enabled". | +| [`GetShiftingFactor`](#generated.RASPHSettings.GetShiftingFactor)() | Get the value of "Shifting Factor". | +| [`GetSize`](#generated.RASPHSettings.GetSize)([unit]) | Get the value of "Size". | +| [`GetSolver`](#generated.RASPHSettings.GetSolver)() | Get "Solver Model" as a string. | +| [`GetSolverModel`](#generated.RASPHSettings.GetSolverModel)() | Get "Solver Model" as a string. | +| [`GetSoundSpeed`](#generated.RASPHSettings.GetSoundSpeed)([unit]) | Get the value of "Sound Speed". | +| [`GetStabilityDegree`](#generated.RASPHSettings.GetStabilityDegree)() | Get the value of "Stability Degree". | +| [`GetStabilityNegFactor`](#generated.RASPHSettings.GetStabilityNegFactor)() | Get the value of "Stability Neg Factor". | +| [`GetStabilityPosFactor`](#generated.RASPHSettings.GetStabilityPosFactor)() | Get the value of "Stability Pos Factor". | +| [`GetStiffFactor`](#generated.RASPHSettings.GetStiffFactor)() | Get the value of "Stiff Factor". | +| [`GetSurfaceTensionBoundaryAngle`](#generated.RASPHSettings.GetSurfaceTensionBoundaryAngle)([unit]) | Get the value of "Surface Tension Boundary Angle". | +| [`GetSurfaceTensionBoundaryFraction`](#generated.RASPHSettings.GetSurfaceTensionBoundaryFraction)() | Get the value of "Surface Tension Boundary Fraction". | +| [`GetSurfaceTensionCoefficient`](#generated.RASPHSettings.GetSurfaceTensionCoefficient)([unit]) | Get the value of "Surface Tension Coefficient". | +| [`GetSurfaceTensionType`](#generated.RASPHSettings.GetSurfaceTensionType)() | Get "Surface Tension Type" as a string. | +| [`GetTimeSet`](#generated.RASPHSettings.GetTimeSet)() | Get the list of time-steps associated to the grid. | +| [`GetTimeStatistics`](#generated.RASPHSettings.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | +| [`GetTimeStep`](#generated.RASPHSettings.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTimestepFactor`](#generated.RASPHSettings.GetTimestepFactor)() | Get the value of "Timestep Factor". | +| [`GetTopologyShape`](#generated.RASPHSettings.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetTurbDistanceFraction`](#generated.RASPHSettings.GetTurbDistanceFraction)() | Get the value of "Turb Distance Fraction". | +| [`GetTurbulenceType`](#generated.RASPHSettings.GetTurbulenceType)() | Get "Turbulence Type" as a string. | +| [`GetTurbulentPrandtl`](#generated.RASPHSettings.GetTurbulentPrandtl)() | Get the value of "Turbulent Prandtl". | +| [`GetTurbulentViscosityMaximumRatio`](#generated.RASPHSettings.GetTurbulentViscosityMaximumRatio)() | Get the value of "Turbulent Viscosity Maximum Ratio". | +| [`GetUpdateCoupledDensity`](#generated.RASPHSettings.GetUpdateCoupledDensity)() | Get the value of "Update Coupled Density". | +| [`GetUseParticlesNeighborsList`](#generated.RASPHSettings.GetUseParticlesNeighborsList)() | Get the value of "Use Particles Neighbors List". | +| [`GetValidKernelTypeValues`](#generated.RASPHSettings.GetValidKernelTypeValues)() | Get a list of all possible values for "Kernel Type". | +| [`GetValidPosCorrectionTypeValues`](#generated.RASPHSettings.GetValidPosCorrectionTypeValues)() | Get a list of all possible values for "Pos Correction Type". | +| [`GetValidSolverModelValues`](#generated.RASPHSettings.GetValidSolverModelValues)() | Get a list of all possible values for "Solver Model". | +| [`GetValidSurfaceTensionTypeValues`](#generated.RASPHSettings.GetValidSurfaceTensionTypeValues)() | Get a list of all possible values for "Surface Tension Type". | +| [`GetValidTurbulenceTypeValues`](#generated.RASPHSettings.GetValidTurbulenceTypeValues)() | Get a list of all possible values for "Turbulence Type". | +| [`GetValidViscosityTypeValues`](#generated.RASPHSettings.GetValidViscosityTypeValues)() | Get a list of all possible values for "Viscosity Type". | +| [`GetValidViscousForceIntegrationValues`](#generated.RASPHSettings.GetValidViscousForceIntegrationValues)() | Get a list of all possible values for "Viscous Force Integration". | +| [`GetVertices`](#generated.RASPHSettings.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | +| [`GetViscosityType`](#generated.RASPHSettings.GetViscosityType)() | Get "Viscosity Type" as a string. | +| [`GetViscousForceIntegration`](#generated.RASPHSettings.GetViscousForceIntegration)() | Get "Viscous Force Integration" as a string. | +| [`GetViscousForceMaximumNumberOfIterations`](#generated.RASPHSettings.GetViscousForceMaximumNumberOfIterations)() | Get the value of "Viscous Force Maximum Number of Iterations". | +| [`GetViscousForceRelativeErrorTolerance`](#generated.RASPHSettings.GetViscousForceRelativeErrorTolerance)() | Get the value of "Viscous Force Relative Error Tolerance". | +| [`GetViscousForceUnderRelaxationFactor`](#generated.RASPHSettings.GetViscousForceUnderRelaxationFactor)() | Get the value of "Viscous Force Under Relaxation Factor". | +| [`GetXsphFactor`](#generated.RASPHSettings.GetXsphFactor)() | Get the value of "Xsph Factor". | +| [`HasGridFunction`](#generated.RASPHSettings.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | +| [`IsCellActive`](#generated.RASPHSettings.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | +| [`IsEulerianSolutionEnabled`](#generated.RASPHSettings.IsEulerianSolutionEnabled)() | Check if the "Eulerian Solution" is enabled. | +| [`IsRelaxedIncompressibilityConstraintEnabled`](#generated.RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled)() | Check if the "Relaxed Incompressibility Constraint" is enabled. | +| [`IsShepardFilterOnDensityEnabled`](#generated.RASPHSettings.IsShepardFilterOnDensityEnabled)() | Check if the "Shepard Filter On Density" is enabled. | +| [`IsShepardFilterOnPressureEnabled`](#generated.RASPHSettings.IsShepardFilterOnPressureEnabled)() | Check if the "Shepard Filter On Pressure" is enabled. | +| [`IterCellVertices`](#generated.RASPHSettings.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | +| [`IterCells`](#generated.RASPHSettings.IterCells)([time_step]) | Iterate on the active grid cells at the given time. | +| [`Modified`](#generated.RASPHSettings.Modified)(\*args, \*\*kwargs) | Resets all the cache information after a change in the subject being tracked. | +| [`RemoveCustomCurve`](#generated.RASPHSettings.RemoveCustomCurve)(name) | Remove the curve from the database :param name: The name of the curve to be removed. | +| [`RemoveCustomProperty`](#generated.RASPHSettings.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | +| [`RemoveOutputVariable`](#generated.RASPHSettings.RemoveOutputVariable)(variable_name) | Removes some output variable. | +| [`RemoveProcess`](#generated.RASPHSettings.RemoveProcess)() | Removes the process from the project. | +| [`SetCS`](#generated.RASPHSettings.SetCS)(value) | Set the value of "C S". | +| [`SetClearyFactor`](#generated.RASPHSettings.SetClearyFactor)(value) | Set the value of "Cleary Factor". | +| [`SetCurrentTimeStep`](#generated.RASPHSettings.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetDensityDevMinus`](#generated.RASPHSettings.SetDensityDevMinus)(value) | Set the value of "Density Dev Minus". | +| [`SetDensityDevPlus`](#generated.RASPHSettings.SetDensityDevPlus)(value) | Set the value of "Density Dev Plus". | +| [`SetDensityRelativeErrorTolerance`](#generated.RASPHSettings.SetDensityRelativeErrorTolerance)(value) | Set the value of "Density Relative Error Tolerance". | +| [`SetDissFactor`](#generated.RASPHSettings.SetDissFactor)(value) | Set the value of "Diss Factor". | +| [`SetDistFactorNorm`](#generated.RASPHSettings.SetDistFactorNorm)(value) | Set the value of "Dist Factor Norm". | +| [`SetDistFactorTang`](#generated.RASPHSettings.SetDistFactorTang)(value) | Set the value of "Dist Factor Tang". | +| [`SetEnabled`](#generated.RASPHSettings.SetEnabled)(value) | Set the value of "Enabled". | +| [`SetEulerianSolutionEnabled`](#generated.RASPHSettings.SetEulerianSolutionEnabled)(value) | Set the value of "Eulerian Solution Enabled". | +| [`SetFluidMaterial`](#generated.RASPHSettings.SetFluidMaterial)(value) | Set the "Fluid Material". | +| [`SetFreeSurfaceDivergenceLimit`](#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit)(value) | Set the value of "Free Surface Divergence Limit". | +| [`SetIncompressibilityRelaxationFactor`](#generated.RASPHSettings.SetIncompressibilityRelaxationFactor)(value) | Set the value of "Incompressibility Relaxation Factor". | +| [`SetKernelDistFactor`](#generated.RASPHSettings.SetKernelDistFactor)(value) | Set the value of "Kernel Dist Factor". | +| [`SetKernelType`](#generated.RASPHSettings.SetKernelType)(value) | Set the value of "Kernel Type". | +| [`SetLimitTurbulentViscosity`](#generated.RASPHSettings.SetLimitTurbulentViscosity)(value) | Set the value of "Limit Turbulent Viscosity". | +| [`SetMaximumExpectedVelocity`](#generated.RASPHSettings.SetMaximumExpectedVelocity)(value[, unit]) | Set the value of "Maximum Expected Velocity". | +| [`SetMaximumNumberOfIterations`](#generated.RASPHSettings.SetMaximumNumberOfIterations)(value) | Set the value of "Maximum Number of Iterations". | +| [`SetMinDistFactor`](#generated.RASPHSettings.SetMinDistFactor)(value) | Set the value of "Min Dist Factor". | +| [`SetNegativePressureFactor`](#generated.RASPHSettings.SetNegativePressureFactor)(value) | Set the value of "Negative Pressure Factor". | +| [`SetNumCellSteps`](#generated.RASPHSettings.SetNumCellSteps)(value) | Set the value of "Num Cell Steps". | +| [`SetNumberOfSteps`](#generated.RASPHSettings.SetNumberOfSteps)(value) | Set the value of "Number of Steps". | +| [`SetPosCorrectionType`](#generated.RASPHSettings.SetPosCorrectionType)(value) | Set the value of "Pos Correction Type". | +| [`SetPressureDeg`](#generated.RASPHSettings.SetPressureDeg)(value) | Set the value of "Pressure Deg". | +| [`SetPressureUnderRelaxationFactor`](#generated.RASPHSettings.SetPressureUnderRelaxationFactor)(value) | Set the value of "Pressure Under Relaxation Factor". | +| [`SetRelaxedIncompressibilityConstraintEnabled`](#generated.RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled)(value) | Set the value of "Relaxed Incompressibility Constraint Enabled". | +| [`SetShepardFilterOnDensityEnabled`](#generated.RASPHSettings.SetShepardFilterOnDensityEnabled)(value) | Set the value of "Shepard Filter On Density Enabled". | +| [`SetShepardFilterOnPressureEnabled`](#generated.RASPHSettings.SetShepardFilterOnPressureEnabled)(value) | Set the value of "Shepard Filter On Pressure Enabled". | +| [`SetShiftingFactor`](#generated.RASPHSettings.SetShiftingFactor)(value) | Set the value of "Shifting Factor". | +| [`SetSize`](#generated.RASPHSettings.SetSize)(value[, unit]) | Set the value of "Size". | +| [`SetSolver`](#generated.RASPHSettings.SetSolver)(value) | Set the value of "Solver Model". | +| [`SetSolverModel`](#generated.RASPHSettings.SetSolverModel)(value) | Set the value of "Solver Model". | +| [`SetSoundSpeed`](#generated.RASPHSettings.SetSoundSpeed)(value[, unit]) | Set the value of "Sound Speed". | +| [`SetStabilityDegree`](#generated.RASPHSettings.SetStabilityDegree)(value) | Set the value of "Stability Degree". | +| [`SetStabilityNegFactor`](#generated.RASPHSettings.SetStabilityNegFactor)(value) | Set the value of "Stability Neg Factor". | +| [`SetStabilityPosFactor`](#generated.RASPHSettings.SetStabilityPosFactor)(value) | Set the value of "Stability Pos Factor". | +| [`SetStiffFactor`](#generated.RASPHSettings.SetStiffFactor)(value) | Set the value of "Stiff Factor". | +| [`SetSurfaceTensionBoundaryAngle`](#generated.RASPHSettings.SetSurfaceTensionBoundaryAngle)(value[, unit]) | Set the value of "Surface Tension Boundary Angle". | +| [`SetSurfaceTensionBoundaryFraction`](#generated.RASPHSettings.SetSurfaceTensionBoundaryFraction)(value) | Set the value of "Surface Tension Boundary Fraction". | +| [`SetSurfaceTensionCoefficient`](#generated.RASPHSettings.SetSurfaceTensionCoefficient)(value[, unit]) | Set the value of "Surface Tension Coefficient". | +| [`SetSurfaceTensionType`](#generated.RASPHSettings.SetSurfaceTensionType)(value) | Set the value of "Surface Tension Type". | +| [`SetTimestepFactor`](#generated.RASPHSettings.SetTimestepFactor)(value) | Set the value of "Timestep Factor". | +| [`SetTurbDistanceFraction`](#generated.RASPHSettings.SetTurbDistanceFraction)(value) | Set the value of "Turb Distance Fraction". | +| [`SetTurbulenceType`](#generated.RASPHSettings.SetTurbulenceType)(value) | Set the value of "Turbulence Type". | +| [`SetTurbulentPrandtl`](#generated.RASPHSettings.SetTurbulentPrandtl)(value) | Set the value of "Turbulent Prandtl". | +| [`SetTurbulentViscosityMaximumRatio`](#generated.RASPHSettings.SetTurbulentViscosityMaximumRatio)(value) | Set the value of "Turbulent Viscosity Maximum Ratio". | +| [`SetUpdateCoupledDensity`](#generated.RASPHSettings.SetUpdateCoupledDensity)(value) | Set the value of "Update Coupled Density". | +| [`SetUseParticlesNeighborsList`](#generated.RASPHSettings.SetUseParticlesNeighborsList)(value) | Set the value of "Use Particles Neighbors List". | +| [`SetViscosityType`](#generated.RASPHSettings.SetViscosityType)(value) | Set the value of "Viscosity Type". | +| [`SetViscousForceIntegration`](#generated.RASPHSettings.SetViscousForceIntegration)(value) | Set the value of "Viscous Force Integration". | +| [`SetViscousForceMaximumNumberOfIterations`](#generated.RASPHSettings.SetViscousForceMaximumNumberOfIterations)(value) | Set the value of "Viscous Force Maximum Number of Iterations". | +| [`SetViscousForceRelativeErrorTolerance`](#generated.RASPHSettings.SetViscousForceRelativeErrorTolerance)(value) | Set the value of "Viscous Force Relative Error Tolerance". | +| [`SetViscousForceUnderRelaxationFactor`](#generated.RASPHSettings.SetViscousForceUnderRelaxationFactor)(value) | Set the value of "Viscous Force Under Relaxation Factor". | +| [`SetXsphFactor`](#generated.RASPHSettings.SetXsphFactor)(value) | Set the value of "Xsph Factor". | @@ -243,7 +263,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -255,7 +275,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -322,30 +342,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -514,6 +532,12 @@ will apply the time_operation to get a single scalar from those values). Set the value of “Eulerian Solution” to False. + + +#### DisableRelaxedIncompressibilityConstraint() + +Set the value of “Relaxed Incompressibility Constraint” to False. + #### DisableShepardFilterOnDensity() @@ -560,6 +584,12 @@ Edit a custom property saved in the database. Set the value of “Eulerian Solution” to True. + + +#### EnableRelaxedIncompressibilityConstraint() + +Set the value of “Relaxed Incompressibility Constraint” to True. + #### EnableShepardFilterOnDensity() @@ -574,16 +604,14 @@ Set the value of “Shepard Filter On Pressure” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -598,28 +626,20 @@ Get all available Fluid Materials. List[[`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial)] A list of [`RAFluidMaterial`](RAFluidMaterial.md#generated.RAFluidMaterial). - - -#### GetBackgroundPressure() - -The Background Pressure parameter was removed from Rocky since 24R1. - -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. @@ -630,65 +650,57 @@ Get the value of “C S”. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -697,39 +709,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -763,16 +771,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -784,7 +790,7 @@ Get the value of “Cleary Factor”. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -862,12 +868,47 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetEnabled() + +Get the value of “Enabled”. + #### GetEulerianSolutionEnabled() Get the value of “Eulerian Solution Enabled”. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFluidMaterial() @@ -889,19 +930,30 @@ Get the value of “Free Surface Divergence Limit”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -923,13 +975,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -937,22 +987,15 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. +Overridden to filter out deprecated property names. -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. + + +#### GetIncompressibilityRelaxationFactor() + +Get the value of “Incompressibility Relaxation Factor”. @@ -992,7 +1035,7 @@ Get the value of “Maximum Number of Iterations”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -1023,31 +1066,27 @@ Get the value of “Num Cell Steps”. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1096,6 +1135,12 @@ Get the value of “Pressure Deg”. Get the value of “Pressure Under Relaxation Factor”. + + +#### GetRelaxedIncompressibilityConstraintEnabled() + +Get the value of “Relaxed Incompressibility Constraint Enabled”. + #### GetShepardFilterOnDensityEnabled() @@ -1213,8 +1258,6 @@ Get “Surface Tension Type” as a string. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1258,16 +1301,14 @@ Get the value of “Timestep Factor”. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1364,6 +1405,30 @@ Get a list of all possible values for “Viscosity Type”. * **Returns:** The returned list is [‘cleary’, ‘morris’, ‘custom’]. + + +#### GetValidViscousForceIntegrationValues() + +Get a list of all possible values for “Viscous Force Integration”. + +* **Returns:** + The returned list is [‘explicit’, ‘implicit’]. + + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + #### GetViscosityType() @@ -1373,6 +1438,33 @@ Get “Viscosity Type” as a string. * **Returns:** The returned value will be one of [‘cleary’, ‘morris’, ‘custom’]. + + +#### GetViscousForceIntegration() + +Get “Viscous Force Integration” as a string. + +* **Returns:** + The returned value will be one of [‘explicit’, ‘implicit’]. + + + +#### GetViscousForceMaximumNumberOfIterations() + +Get the value of “Viscous Force Maximum Number of Iterations”. + + + +#### GetViscousForceRelativeErrorTolerance() + +Get the value of “Viscous Force Relative Error Tolerance”. + + + +#### GetViscousForceUnderRelaxationFactor() + +Get the value of “Viscous Force Under Relaxation Factor”. + #### GetXsphFactor() @@ -1381,32 +1473,28 @@ Get the value of “Xsph Factor”. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1416,6 +1504,12 @@ Checks if the given cell is active or not Check if the “Eulerian Solution” is enabled. + + +#### IsRelaxedIncompressibilityConstraintEnabled() + +Check if the “Relaxed Incompressibility Constraint” is enabled. + #### IsShepardFilterOnDensityEnabled() @@ -1430,13 +1524,13 @@ Check if the “Shepard Filter On Pressure” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1446,12 +1540,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1498,12 +1592,6 @@ Removes some output variable. Removes the process from the project. - - -#### SetBackgroundPressure(value: str | float, unit: str | None = None) - -The Background Pressure parameter was removed from Rocky since 24R1. - #### SetCS(value: str | float) @@ -1585,6 +1673,15 @@ Set the value of “Dist Factor Tang”. * **Parameters:** **value** – The value to set. This value can be an expression with input variables or float type. + + +#### SetEnabled(value: bool) + +Set the value of “Enabled”. + +* **Parameters:** + **value** – The value to set. + #### SetEulerianSolutionEnabled(value: bool) @@ -1609,6 +1706,15 @@ Set the “Fluid Material”. Set the value of “Free Surface Divergence Limit”. +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetIncompressibilityRelaxationFactor(value: str | float) + +Set the value of “Incompressibility Relaxation Factor”. + * **Parameters:** **value** – The value to set. This value can be an expression with input variables or float type. @@ -1725,6 +1831,15 @@ Set the value of “Pressure Under Relaxation Factor”. * **Parameters:** **value** – The value to set. This value can be an expression with input variables or float type. + + +#### SetRelaxedIncompressibilityConstraintEnabled(value: bool) + +Set the value of “Relaxed Incompressibility Constraint Enabled”. + +* **Parameters:** + **value** – The value to set. + #### SetShepardFilterOnDensityEnabled(value: bool) @@ -1946,6 +2061,44 @@ Set the value of “Viscosity Type”. * **Raises:** **RockyApiError** – If value is not a valid “Viscosity Type” option. + + +#### SetViscousForceIntegration(value: str) + +Set the value of “Viscous Force Integration”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘explicit’, ‘implicit’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Viscous Force Integration” option. + + + +#### SetViscousForceMaximumNumberOfIterations(value: str | int) + +Set the value of “Viscous Force Maximum Number of Iterations”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetViscousForceRelativeErrorTolerance(value: str | float) + +Set the value of “Viscous Force Relative Error Tolerance”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + + + +#### SetViscousForceUnderRelaxationFactor(value: str | float) + +Set the value of “Viscous Force Under Relaxation Factor”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + #### SetXsphFactor(value: str | float) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RASimulatorRun.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RASimulatorRun.md index fec101cbdd..eebb7dea4f 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RASimulatorRun.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RASimulatorRun.md @@ -69,7 +69,6 @@ simulator_run = study.GetSimulatorRun() | [`GetCellNumberOfVertices`](#generated.RASimulatorRun.GetCellNumberOfVertices)(cell[, time_step]) | Get an array containing the number of vertices of each cell. | | [`GetCellPointsAsFunction`](#generated.RASimulatorRun.GetCellPointsAsFunction)([time_step]) | Get a function for the points (vertices) of each cell. | | [`GetCellVolumeAsArray`](#generated.RASimulatorRun.GetCellVolumeAsArray)([time_step]) | Get an array with the volume of each cell. | -| [`GetCollectForcesForFemAnalysis`](#generated.RASimulatorRun.GetCollectForcesForFemAnalysis)() | Deprecated: Use this method from RAStudy instead | | [`GetContactNeighboringDistanceBetweenParticles`](#generated.RASimulatorRun.GetContactNeighboringDistanceBetweenParticles)([unit]) | Get the value of "Contact Neighboring Distance Between Particles". | | [`GetContactNeighboringDistanceBetweenParticlesAndTriangles`](#generated.RASimulatorRun.GetContactNeighboringDistanceBetweenParticlesAndTriangles)([unit]) | Get the value of "Contact Neighboring Distance Between Particles And Triangles". | | [`GetCurve`](#generated.RASimulatorRun.GetCurve)(curve_name[, simulation_name, ...]) | Override base class method to check for a request of a grid function statistic. | @@ -79,12 +78,15 @@ simulator_run = study.GetSimulatorRun() | [`GetDisableTrianglesOnPeriodicBoundaries`](#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries)() | Get the value of "Disable Triangles On Periodic Boundaries". | | [`GetDragLimiterFactor`](#generated.RASimulatorRun.GetDragLimiterFactor)() | Get the value of "Drag Limiter Factor". | | [`GetElementCurve`](#generated.RASimulatorRun.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RASimulatorRun.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RASimulatorRun.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetFixedTimestep`](#generated.RASimulatorRun.GetFixedTimestep)([unit]) | Get the value of "Fixed Timestep". | | [`GetFluentOutputsMultiplier`](#generated.RASimulatorRun.GetFluentOutputsMultiplier)() | Get the value of "Fluent Outputs Multiplier". | | [`GetGeometryQuantity`](#generated.RASimulatorRun.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RASimulatorRun.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RASimulatorRun.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RASimulatorRun.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RASimulatorRun.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RASimulatorRun.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetJointElasticRatio`](#generated.RASimulatorRun.GetJointElasticRatio)() | Get the value of "Joint Elastic Ratio". | | [`GetLinearHystDamp`](#generated.RASimulatorRun.GetLinearHystDamp)() | Get the value of "Linear Hyst Damp". | | [`GetLoadingNSteps`](#generated.RASimulatorRun.GetLoadingNSteps)() | Get the value of "Loading N Steps". | @@ -95,6 +97,12 @@ simulator_run = study.GetSimulatorRun() | [`GetModulesOutputPropertiesData`](#generated.RASimulatorRun.GetModulesOutputPropertiesData)() | | | [`GetModulesOutputPropertyEnabled`](#generated.RASimulatorRun.GetModulesOutputPropertyEnabled)(\*output_property) | Retrieve enable state of given "Modules Output Property". | | [`GetMoveCfdCellsWithRockyBoundaries`](#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries)() | Get the value of "Move Cfd Cells With Rocky Boundaries". | +| [`GetMpiHeterogeneous`](#generated.RASimulatorRun.GetMpiHeterogeneous)() | Get the value of "Mpi Heterogeneous". | +| [`GetMpiHostfile`](#generated.RASimulatorRun.GetMpiHostfile)() | Get the value of "Mpi Hostfile". | +| [`GetMpiHosts`](#generated.RASimulatorRun.GetMpiHosts)() | Get the value of "Mpi Hosts". | +| [`GetMpiNumberOfProcesses`](#generated.RASimulatorRun.GetMpiNumberOfProcesses)() | Get the value of "Mpi Number of Processes". | +| [`GetMpiNumberOfThreads`](#generated.RASimulatorRun.GetMpiNumberOfThreads)() | Get the value of "Mpi Number of Threads". | +| [`GetMpiWithinScheduler`](#generated.RASimulatorRun.GetMpiWithinScheduler)() | Get the value of "Mpi Within Scheduler". | | [`GetMultiGpuSlicingDirection`](#generated.RASimulatorRun.GetMultiGpuSlicingDirection)() | Get "Multi Gpu Slicing Direction" as a string. | | [`GetNegateInitialOverlaps`](#generated.RASimulatorRun.GetNegateInitialOverlaps)() | Get the value of "Negate Initial Overlaps". | | [`GetNeighborSearchModel`](#generated.RASimulatorRun.GetNeighborSearchModel)() | Get "Neighbor Search Model" as a string. | @@ -108,15 +116,13 @@ simulator_run = study.GetSimulatorRun() | [`GetOverRelaxationCoefficient`](#generated.RASimulatorRun.GetOverRelaxationCoefficient)() | Get the value of "Over Relaxation Coefficient". | | [`GetOverlapParticlesDelay`](#generated.RASimulatorRun.GetOverlapParticlesDelay)([unit]) | Get the value of "Overlap Particles Delay". | | [`GetParticleSizeLimitForReordering`](#generated.RASimulatorRun.GetParticleSizeLimitForReordering)([unit]) | Get the value of "Particle Size Limit For Reordering". | +| [`GetProcessingUnit`](#generated.RASimulatorRun.GetProcessingUnit)() | Get "Processing Unit" as a string. | | [`GetRefineConcaveSearch`](#generated.RASimulatorRun.GetRefineConcaveSearch)() | Get the value of "Refine Concave Search". | | [`GetReleaseParticlesWithoutOverlapCheck`](#generated.RASimulatorRun.GetReleaseParticlesWithoutOverlapCheck)() | Get the value of "Release Particles Without Overlap Check". | | [`GetResetOnlyPhysicalContactsData`](#generated.RASimulatorRun.GetResetOnlyPhysicalContactsData)() | Get the value of "Reset Only Physical Contacts Data". | | [`GetResumeDataFrequency`](#generated.RASimulatorRun.GetResumeDataFrequency)() | Get the value of "Resume Data Frequency". | | [`GetSimulationDuration`](#generated.RASimulatorRun.GetSimulationDuration)([unit]) | Get the value of "Simulation Duration". | -| [`GetSimulationOutputFrequency`](#generated.RASimulatorRun.GetSimulationOutputFrequency)([unit]) | Deprecated: Use GetTimeInterval instead. | -| [`GetSimulationTarget`](#generated.RASimulatorRun.GetSimulationTarget)() | Get "Simulation Target" as a string. | | [`GetSolverCurvesFrequency`](#generated.RASimulatorRun.GetSolverCurvesFrequency)() | Get the value of "Solver Curves Frequency". | -| [`GetSolverCurvesOutputFrequency`](#generated.RASimulatorRun.GetSolverCurvesOutputFrequency)() | Deprecated: Use GetSolverCurvesFrequency instead. | | [`GetSortingDistanceFactor`](#generated.RASimulatorRun.GetSortingDistanceFactor)() | Get the value of "Sorting Distance Factor". | | [`GetSpecialReorderingForWidePsd`](#generated.RASimulatorRun.GetSpecialReorderingForWidePsd)() | Get the value of "Special Reordering For Wide Psd". | | [`GetStandardOutputPropertiesData`](#generated.RASimulatorRun.GetStandardOutputPropertiesData)() | | @@ -141,16 +147,15 @@ simulator_run = study.GetSimulatorRun() | [`GetUseDpmBlockingEffectForSinglePhaseSimulations`](#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations)() | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | | [`GetUseDragLimiterFactor`](#generated.RASimulatorRun.GetUseDragLimiterFactor)() | Get the value of "Use Drag Limiter Factor". | | [`GetUseFixedTimestep`](#generated.RASimulatorRun.GetUseFixedTimestep)() | Get the value of "Use Fixed Timestep". | +| [`GetUseMpi`](#generated.RASimulatorRun.GetUseMpi)() | Get the value of "Use Mpi". | | [`GetUseNonRoundTorqueCorrection`](#generated.RASimulatorRun.GetUseNonRoundTorqueCorrection)() | Get the value of "Use Non Round Torque Correction". | | [`GetUseSortingDistanceFactor`](#generated.RASimulatorRun.GetUseSortingDistanceFactor)() | Get the value of "Use Sorting Distance Factor". | | [`GetValidDeformableMassMatrixTypeValues`](#generated.RASimulatorRun.GetValidDeformableMassMatrixTypeValues)() | Get a list of all possible values for "Deformable Mass Matrix Type". | | [`GetValidMultiGpuSlicingDirectionValues`](#generated.RASimulatorRun.GetValidMultiGpuSlicingDirectionValues)() | Get a list of all possible values for "Multi Gpu Slicing Direction". | | [`GetValidNeighborSearchModelValues`](#generated.RASimulatorRun.GetValidNeighborSearchModelValues)() | Get a list of all possible values for "Neighbor Search Model". | -| [`GetValidSimulationTargetValues`](#generated.RASimulatorRun.GetValidSimulationTargetValues)() | Get a list of all possible values for "Simulation Target". | +| [`GetValidProcessingUnitValues`](#generated.RASimulatorRun.GetValidProcessingUnitValues)() | Get a list of all possible values for "Processing Unit". | | [`GetValidTimestepModelValues`](#generated.RASimulatorRun.GetValidTimestepModelValues)() | Get a list of all possible values for "Timestep Model". | -| [`GetWearEnergySpectraBreakageDelayAfterRelease`](#generated.RASimulatorRun.GetWearEnergySpectraBreakageDelayAfterRelease)([unit]) | Deprecated: Use GetEnergySpectraDelayAfterRelease or GetBreakageDelayAfterRelease instead. | -| [`GetWearEnergySpectraBreakageStart`](#generated.RASimulatorRun.GetWearEnergySpectraBreakageStart)([unit]) | Deprecated: Use GetWearStart or GetBreakageStart instead. | -| [`GetWearGeometryUpdateFrequency`](#generated.RASimulatorRun.GetWearGeometryUpdateFrequency)([unit]) | Deprecated: Use GetWearGeometryUpdateInterval instead. | +| [`GetVertices`](#generated.RASimulatorRun.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`GetWearGeometryUpdateInterval`](#generated.RASimulatorRun.GetWearGeometryUpdateInterval)([unit]) | Get the value of "Wear Geometry Update Interval". | | [`GetWearStart`](#generated.RASimulatorRun.GetWearStart)([unit]) | Get the value of "Wear Start". | | [`HasFEMForcesEnabled`](#generated.RASimulatorRun.HasFEMForcesEnabled)() | Whether the simulation is configured to collect forces for FEM analysis. | @@ -175,7 +180,6 @@ simulator_run = study.GetSimulatorRun() | [`SetBreakageDelayAfterRelease`](#generated.RASimulatorRun.SetBreakageDelayAfterRelease)(value[, unit]) | Set the value of "Breakage Delay After Release". | | [`SetBreakageOverlapFactor`](#generated.RASimulatorRun.SetBreakageOverlapFactor)(value) | Set the value of "Breakage Overlap Factor". | | [`SetBreakageStart`](#generated.RASimulatorRun.SetBreakageStart)(value[, unit]) | Set the value of "Breakage Start". | -| [`SetCollectForcesForFemAnalysis`](#generated.RASimulatorRun.SetCollectForcesForFemAnalysis)(value) | Deprecated: Use this method from RAStudy instead | | [`SetContactNeighboringDistanceBetweenParticles`](#generated.RASimulatorRun.SetContactNeighboringDistanceBetweenParticles)(value) | Set the value of "Contact Neighboring Distance Between Particles". | | [`SetContactNeighboringDistanceBetweenParticlesAndTriangles`](#generated.RASimulatorRun.SetContactNeighboringDistanceBetweenParticlesAndTriangles)(value) | Set the value of "Contact Neighboring Distance Between Particles And Triangles". | | [`SetCurrentTimeStep`](#generated.RASimulatorRun.SetCurrentTimeStep)(time_step) | Sets the current time step. | @@ -193,6 +197,12 @@ simulator_run = study.GetSimulatorRun() | [`SetModulesOutputPropertiesData`](#generated.RASimulatorRun.SetModulesOutputPropertiesData)(data_dict) | Set the current value of "Modules Output Properties". | | [`SetModulesOutputPropertyEnabled`](#generated.RASimulatorRun.SetModulesOutputPropertyEnabled)(...) | Set enable state of given "Modules Output Property". | | [`SetMoveCfdCellsWithRockyBoundaries`](#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries)(value) | Set the value of "Move Cfd Cells With Rocky Boundaries". | +| [`SetMpiHeterogeneous`](#generated.RASimulatorRun.SetMpiHeterogeneous)(value) | Set the value of "Mpi Heterogeneous". | +| [`SetMpiHostfile`](#generated.RASimulatorRun.SetMpiHostfile)(value) | Set the value of "Mpi Hostfile". | +| [`SetMpiHosts`](#generated.RASimulatorRun.SetMpiHosts)(value) | Set the value of "Mpi Hosts". | +| [`SetMpiNumberOfProcesses`](#generated.RASimulatorRun.SetMpiNumberOfProcesses)(value) | Set the value of "Mpi Number of Processes". | +| [`SetMpiNumberOfThreads`](#generated.RASimulatorRun.SetMpiNumberOfThreads)(value) | Set the value of "Mpi Number of Threads". | +| [`SetMpiWithinScheduler`](#generated.RASimulatorRun.SetMpiWithinScheduler)(value) | Set the value of "Mpi Within Scheduler". | | [`SetMultiGpuSlicingDirection`](#generated.RASimulatorRun.SetMultiGpuSlicingDirection)(value) | Set the value of "Multi Gpu Slicing Direction". | | [`SetNegateInitialOverlaps`](#generated.RASimulatorRun.SetNegateInitialOverlaps)(value) | Set the value of "Negate Initial Overlaps". | | [`SetNeighborSearchModel`](#generated.RASimulatorRun.SetNeighborSearchModel)(value) | Set the value of "Neighbor Search Model". | @@ -202,15 +212,13 @@ simulator_run = study.GetSimulatorRun() | [`SetOverRelaxationCoefficient`](#generated.RASimulatorRun.SetOverRelaxationCoefficient)(value) | Set the value of "Over Relaxation Coefficient". | | [`SetOverlapParticlesDelay`](#generated.RASimulatorRun.SetOverlapParticlesDelay)(value[, unit]) | Set the value of "Overlap Particles Delay". | | [`SetParticleSizeLimitForReordering`](#generated.RASimulatorRun.SetParticleSizeLimitForReordering)(value[, unit]) | Set the value of "Particle Size Limit For Reordering". | +| [`SetProcessingUnit`](#generated.RASimulatorRun.SetProcessingUnit)(value) | Set the value of "Processing Unit". | | [`SetRefineConcaveSearch`](#generated.RASimulatorRun.SetRefineConcaveSearch)(value) | Set the value of "Refine Concave Search". | | [`SetReleaseParticlesWithoutOverlapCheck`](#generated.RASimulatorRun.SetReleaseParticlesWithoutOverlapCheck)(value) | Set the value of "Release Particles Without Overlap Check". | | [`SetResetOnlyPhysicalContactsData`](#generated.RASimulatorRun.SetResetOnlyPhysicalContactsData)(value) | Set the value of "Reset Only Physical Contacts Data". | | [`SetResumeDataFrequency`](#generated.RASimulatorRun.SetResumeDataFrequency)(value) | Set the value of "Resume Data Frequency". | | [`SetSimulationDuration`](#generated.RASimulatorRun.SetSimulationDuration)(value[, unit]) | Set the value of "Simulation Duration". | -| [`SetSimulationOutputFrequency`](#generated.RASimulatorRun.SetSimulationOutputFrequency)(value[, unit]) | Deprecated: Use SetTimeInterval instead. | -| [`SetSimulationTarget`](#generated.RASimulatorRun.SetSimulationTarget)(value) | Set the value of "Simulation Target". | | [`SetSolverCurvesFrequency`](#generated.RASimulatorRun.SetSolverCurvesFrequency)(value) | Set the value of "Solver Curves Frequency". | -| [`SetSolverCurvesOutputFrequency`](#generated.RASimulatorRun.SetSolverCurvesOutputFrequency)(value) | Deprecated: Use SetSolverCurvesFrequency instead. | | [`SetSortingDistanceFactor`](#generated.RASimulatorRun.SetSortingDistanceFactor)(value) | Set the value of "Sorting Distance Factor". | | [`SetSpecialReorderingForWidePsd`](#generated.RASimulatorRun.SetSpecialReorderingForWidePsd)(value) | Set the value of "Special Reordering For Wide Psd". | | [`SetStandardOutputPropertiesData`](#generated.RASimulatorRun.SetStandardOutputPropertiesData)(data_dict) | Set the current value of "Standard Output Properties". | @@ -232,11 +240,9 @@ simulator_run = study.GetSimulatorRun() | [`SetUseDpmBlockingEffectForSinglePhaseSimulations`](#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations)(value) | The "Use DPM Blocking Effect For Single Phase Simulations" parameter was removed from Rocky since 25R2. | | [`SetUseDragLimiterFactor`](#generated.RASimulatorRun.SetUseDragLimiterFactor)(value) | Set the value of "Use Drag Limiter Factor". | | [`SetUseFixedTimestep`](#generated.RASimulatorRun.SetUseFixedTimestep)(value) | Set the value of "Use Fixed Timestep". | +| [`SetUseMpi`](#generated.RASimulatorRun.SetUseMpi)(value) | Set the value of "Use Mpi". | | [`SetUseNonRoundTorqueCorrection`](#generated.RASimulatorRun.SetUseNonRoundTorqueCorrection)(value) | Set the value of "Use Non Round Torque Correction". | | [`SetUseSortingDistanceFactor`](#generated.RASimulatorRun.SetUseSortingDistanceFactor)(value) | Set the value of "Use Sorting Distance Factor". | -| [`SetWearEnergySpectraBreakageDelayAfterRelease`](#generated.RASimulatorRun.SetWearEnergySpectraBreakageDelayAfterRelease)(value) | Deprecated: Use SetEnergySpectraDelayAfterRelease or SetBreakageDelayAfterRelease instead. | -| [`SetWearEnergySpectraBreakageStart`](#generated.RASimulatorRun.SetWearEnergySpectraBreakageStart)(value[, unit]) | Deprecated: Use SetWearStart or SetBreakageStart instead. | -| [`SetWearGeometryUpdateFrequency`](#generated.RASimulatorRun.SetWearGeometryUpdateFrequency)(value[, unit]) | Deprecated: Use GetWearGeometryUpdateInterval instead. | | [`SetWearGeometryUpdateInterval`](#generated.RASimulatorRun.SetWearGeometryUpdateInterval)(value[, unit]) | Set the value of "Wear Geometry Update Interval". | | [`SetWearStart`](#generated.RASimulatorRun.SetWearStart)(value[, unit]) | Set the value of "Wear Start". | @@ -297,7 +303,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -309,7 +315,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -376,30 +382,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -690,16 +694,14 @@ Set the value of “Use 3Rd Power For Cfd Cgm” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -738,20 +740,18 @@ Deprecated: Use GetAvailableStandardOutputProperties instead. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. @@ -780,65 +780,57 @@ Get the value of “Breakage Start”. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -847,39 +839,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -913,25 +901,17 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) - - -#### GetCollectForcesForFemAnalysis() - -Deprecated: Use this method from RAStudy instead - #### GetContactNeighboringDistanceBetweenParticles(unit: str | None = None) @@ -952,7 +932,7 @@ Get the value of “Contact Neighboring Distance Between Particles And Triangles -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -1015,6 +995,35 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetFixedTimestep(unit: str | None = None) @@ -1036,19 +1045,30 @@ Get the value of “Fluent Outputs Multiplier”. Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -1070,13 +1090,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -1084,22 +1102,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -1127,7 +1132,7 @@ Get the value of “Maximum Number of Iterations”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -1172,6 +1177,42 @@ Retrieve enable state of given “Modules Output Property”. Get the value of “Move Cfd Cells With Rocky Boundaries”. + + +#### GetMpiHeterogeneous() + +Get the value of “Mpi Heterogeneous”. + + + +#### GetMpiHostfile() + +Get the value of “Mpi Hostfile”. + + + +#### GetMpiHosts() + +Get the value of “Mpi Hosts”. + + + +#### GetMpiNumberOfProcesses() + +Get the value of “Mpi Number of Processes”. + + + +#### GetMpiNumberOfThreads() + +Get the value of “Mpi Number of Threads”. + + + +#### GetMpiWithinScheduler() + +Get the value of “Mpi Within Scheduler”. + #### GetMultiGpuSlicingDirection() @@ -1198,31 +1239,27 @@ Get “Neighbor Search Model” as a string. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -1286,6 +1323,15 @@ Get the value of “Particle Size Limit For Reordering”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “m”. + + +#### GetProcessingUnit() + +Get “Processing Unit” as a string. + +* **Returns:** + The returned value will be one of [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. + #### GetRefineConcaveSearch() @@ -1319,33 +1365,12 @@ Get the value of “Simulation Duration”. * **Parameters:** **unit** – The unit for the returned value. If no unit is provided, the returned value will be in “s”. - - -#### GetSimulationOutputFrequency(unit: str | None = None) - -Deprecated: Use GetTimeInterval instead. - - - -#### GetSimulationTarget() - -Get “Simulation Target” as a string. - -* **Returns:** - The returned value will be one of [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. - #### GetSolverCurvesFrequency() Get the value of “Solver Curves Frequency”. - - -#### GetSolverCurvesOutputFrequency() - -Deprecated: Use GetSolverCurvesFrequency instead. - #### GetSortingDistanceFactor() @@ -1408,8 +1433,6 @@ Get the value of “Time Interval”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -1456,16 +1479,14 @@ Get “Timestep Model” as a string. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -1536,6 +1557,12 @@ Get the value of “Use Drag Limiter Factor”. Get the value of “Use Fixed Timestep”. + + +#### GetUseMpi() + +Get the value of “Use Mpi”. + #### GetUseNonRoundTorqueCorrection() @@ -1575,11 +1602,11 @@ Get a list of all possible values for “Neighbor Search Model”. * **Returns:** The returned list is [‘BVH’, ‘RegularGrid’, ‘SparseGrid’]. - + -#### GetValidSimulationTargetValues() +#### GetValidProcessingUnitValues() -Get a list of all possible values for “Simulation Target”. +Get a list of all possible values for “Processing Unit”. * **Returns:** The returned list is [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. @@ -1593,34 +1620,20 @@ Get a list of all possible values for “Timestep Model”. * **Returns:** The returned list is [‘constant’, ‘variable’]. - - -#### GetWearEnergySpectraBreakageDelayAfterRelease(unit: str | None = None) - -Deprecated: Use GetEnergySpectraDelayAfterRelease or GetBreakageDelayAfterRelease instead. - -“Wear / Breakage Delay after Release” is now: -: 1.Breakage Start - -The default value that is being return is the Breakage value. + - +#### GetVertices(time_step: str | int | ITimeStep = 'current') -#### GetWearEnergySpectraBreakageStart(unit: str | None = None) +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. -Deprecated: Use GetWearStart or GetBreakageStart instead. - -“Wear / Breakage Start Time” was broken into two: -: 1.Wear Start - 2.Breakage Start - -The default value that is being return is the Breakage value. - - - -#### GetWearGeometryUpdateFrequency(unit: str | None = None) - -Deprecated: Use GetWearGeometryUpdateInterval instead. +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. @@ -1648,14 +1661,12 @@ Whether the simulation is configured to collect forces for FEM analysis. -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -1667,19 +1678,17 @@ Whether the “HTC” is being calculated. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1722,13 +1731,13 @@ Check if the “Use 3Rd Power For Cfd Cgm” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1738,12 +1747,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1835,12 +1844,6 @@ Set the value of “Breakage Start”. * **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”. - - -#### SetCollectForcesForFemAnalysis(value: bool) - -Deprecated: Use this method from RAStudy instead - #### SetContactNeighboringDistanceBetweenParticles(value: str | float, unit: str | None = None) @@ -1997,6 +2000,60 @@ Set enable state of given “Modules Output Property”. Set the value of “Move Cfd Cells With Rocky Boundaries”. +* **Parameters:** + **value** – The value to set. + + + +#### SetMpiHeterogeneous(value: bool) + +Set the value of “Mpi Heterogeneous”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetMpiHostfile(value: str) + +Set the value of “Mpi Hostfile”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetMpiHosts(value: str) + +Set the value of “Mpi Hosts”. + +* **Parameters:** + **value** – The value to set. + + + +#### SetMpiNumberOfProcesses(value: str | int) + +Set the value of “Mpi Number of Processes”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMpiNumberOfThreads(value: str | int) + +Set the value of “Mpi Number of Threads”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or int type. + + + +#### SetMpiWithinScheduler(value: bool) + +Set the value of “Mpi Within Scheduler”. + * **Parameters:** **value** – The value to set. @@ -2081,6 +2138,17 @@ Set the value of “Particle Size Limit For Reordering”. * **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”. + + +#### SetProcessingUnit(value: str) + +Set the value of “Processing Unit”. + +* **Parameters:** + **value** – The value to set. Must be one of [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. +* **Raises:** + **RockyApiError** – If value is not a valid “Processing Unit” option. + #### SetRefineConcaveSearch(value: bool) @@ -2127,23 +2195,6 @@ Set the value of “Simulation Duration”. * **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”. - - -#### SetSimulationOutputFrequency(value: str | float, unit: str | None = None) - -Deprecated: Use SetTimeInterval instead. - - - -#### SetSimulationTarget(value: str) - -Set the value of “Simulation Target”. - -* **Parameters:** - **value** – The value to set. Must be one of [‘CPU’, ‘GPU’, ‘MULTI_GPU’]. -* **Raises:** - **RockyApiError** – If value is not a valid “Simulation Target” option. - #### SetSolverCurvesFrequency(value: str | int) @@ -2153,12 +2204,6 @@ Set the value of “Solver Curves Frequency”. * **Parameters:** **value** – The value to set. This value can be an expression with input variables or int type. - - -#### SetSolverCurvesOutputFrequency(value: str | int) - -Deprecated: Use SetSolverCurvesFrequency instead. - #### SetSortingDistanceFactor(value: str | float) @@ -2350,6 +2395,15 @@ Set the value of “Use Drag Limiter Factor”. Set the value of “Use Fixed Timestep”. +* **Parameters:** + **value** – The value to set. + + + +#### SetUseMpi(value: bool) + +Set the value of “Use Mpi”. + * **Parameters:** **value** – The value to set. @@ -2371,35 +2425,6 @@ Set the value of “Use Sorting Distance Factor”. * **Parameters:** **value** – The value to set. - - -#### SetWearEnergySpectraBreakageDelayAfterRelease(value: str | float, unit: str | None = None) - -Deprecated: Use SetEnergySpectraDelayAfterRelease or SetBreakageDelayAfterRelease instead. - -“Wear / Breakage Delay after Release” is now: -: 1.Breakage Start - -Wear doesn’t have Delay after Release anymore. - - - -#### SetWearEnergySpectraBreakageStart(value: str | float, unit: str | None = None) - -Deprecated: Use SetWearStart or SetBreakageStart instead. - -“Wear / Breakage Start Time” was broken into two: -: 1.Wear Start - 2.Breakage Start - -All the three values are being set with the same received value. - - - -#### SetWearGeometryUpdateFrequency(value: str | float, unit: str | None = None) - -Deprecated: Use GetWearGeometryUpdateInterval instead. - #### SetWearGeometryUpdateInterval(value: str | float, unit: str | None = None) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAStreamlinesUserProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAStreamlinesUserProcess.md index 53862cde31..d35d394270 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAStreamlinesUserProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAStreamlinesUserProcess.md @@ -42,10 +42,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNamesAssociation`](#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetDirection`](#generated.RAStreamlinesUserProcess.GetDirection)() | Get "Direction" as a string. | | [`GetElementCurve`](#generated.RAStreamlinesUserProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RAStreamlinesUserProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RAStreamlinesUserProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RAStreamlinesUserProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RAStreamlinesUserProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RAStreamlinesUserProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RAStreamlinesUserProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RAStreamlinesUserProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RAStreamlinesUserProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMaximumLength`](#generated.RAStreamlinesUserProcess.GetMaximumLength)([unit]) | Get the value of "Maximum Length". | | [`GetMeshColoring`](#generated.RAStreamlinesUserProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetNumberOfCells`](#generated.RAStreamlinesUserProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | @@ -60,6 +63,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStep`](#generated.RAStreamlinesUserProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RAStreamlinesUserProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | | [`GetValidDirectionValues`](#generated.RAStreamlinesUserProcess.GetValidDirectionValues)() | Get a list of all possible values for "Direction". | +| [`GetVertices`](#generated.RAStreamlinesUserProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RAStreamlinesUserProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RAStreamlinesUserProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RAStreamlinesUserProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -134,7 +138,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -146,7 +150,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -213,30 +217,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -429,16 +431,14 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -451,83 +451,73 @@ Get available planar surfaces that can be used to generate Streamlines. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -536,39 +526,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -602,22 +588,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -668,25 +652,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -708,13 +732,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -722,22 +744,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -750,7 +759,7 @@ Get the value of “Maximum Length”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -763,31 +772,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -845,8 +850,6 @@ Get the value of “Spacing”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -884,16 +887,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -906,46 +907,57 @@ Get a list of all possible values for “Direction”. * **Returns:** The returned list is [‘forward’, ‘backward’, ‘both’]. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -955,12 +967,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RAStudy.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RAStudy.md index 08a7fc5946..cd511881c2 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RAStudy.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RAStudy.md @@ -37,72 +37,67 @@ various common actions related to simulations: **Methods:** | Name | Description | -|----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`CanResumeSimulation`](#generated.RAStudy.CanResumeSimulation)() | Whether the simulation can be resumed. | -| [`CreateContinuousInjection`](#generated.RAStudy.CreateContinuousInjection)(entry_point, particle) | Create a particle input with the given entry_point and particle. | -| [`CreateFeedConveyor`](#generated.RAStudy.CreateFeedConveyor)() | Creates a new feed conveyor and add it to the project. | -| [`CreateInlet`](#generated.RAStudy.CreateInlet)() | Create a new inlet and add it to the project. | -| [`CreateMaterialAndRelatedInteractions`](#generated.RAStudy.CreateMaterialAndRelatedInteractions)([...]) | Deprecated: Use `CreateSolidMaterialAndRelatedInteractions()` instead. | -| [`CreateOutlet`](#generated.RAStudy.CreateOutlet)(exit_point) | Create an outlet with the given exit point. | -| [`CreateParticle`](#generated.RAStudy.CreateParticle)() | Create a particle in the study with default values. | -| [`CreateParticleInlet`](#generated.RAStudy.CreateParticleInlet)(entry_point, particle) | Create a particle inlet with the given entry_point and particle. | -| [`CreateReceivingConveyor`](#generated.RAStudy.CreateReceivingConveyor)() | Creates a new receiving conveyor and add it to the project. | -| [`CreateVolumeFill`](#generated.RAStudy.CreateVolumeFill)([particle, name, mass, ...]) | Creates a volume fill with the given properties. | -| [`CreateVolumetricInlet`](#generated.RAStudy.CreateVolumetricInlet)([particle, name, ...]) | Creates a volumetric inlet with the given properties. | -| [`DeleteResults`](#generated.RAStudy.DeleteResults)() | Called to delete any results we currently have from a simulation. | -| [`ExtendSimulation`](#generated.RAStudy.ExtendSimulation)([extension_amount, time, ...]) | Extend the simulation: either its duration, the duration of an inlet in the study or the duration of a periodic motion frame. | -| [`GetAirFlow`](#generated.RAStudy.GetAirFlow)() | Get the RAAirFlow object (if applicable). | -| [`GetCFDCoupling`](#generated.RAStudy.GetCFDCoupling)() | Get the current CFD coupling object. | -| [`GetCalculations`](#generated.RAStudy.GetCalculations)() | Get the project's Calculations. | -| [`GetCollectForcesForFemAnalysis`](#generated.RAStudy.GetCollectForcesForFemAnalysis)() | Checks wheter the Collision Statistics modules are colecting FEM Forces for analysis | -| [`GetContactData`](#generated.RAStudy.GetContactData)() | Get the RAContactData object. | -| [`GetCustomerName`](#generated.RAStudy.GetCustomerName)() | Get the study customer name. | -| [`GetDescription`](#generated.RAStudy.GetDescription)() | Get the study description. | -| [`GetDomainSettings`](#generated.RAStudy.GetDomainSettings)() | Get the study's Domain Settings. | -| [`GetElementCurve`](#generated.RAStudy.GetElementCurve)(element_name, curve_name[, ...]) | Get the curve matching a given element name and curve name. | -| [`GetExportToolkit`](#generated.RAStudy.GetExportToolkit)() | Get a RAExportToolkit object related to this RAStudy. | -| [`GetFEMForcesAnalysisModules`](#generated.RAStudy.GetFEMForcesAnalysisModules)(module_collection) | Get the name and the FEM Forces property for all available Boundary Collision Statistics modules | -| [`GetGeometry`](#generated.RAStudy.GetGeometry)(geometry_name) | Get the geometry with the given name | -| [`GetGeometryCollection`](#generated.RAStudy.GetGeometryCollection)() | Get the study's Geometry Collection. | -| [`GetInletsOutletsCollection`](#generated.RAStudy.GetInletsOutletsCollection)() | Get the study's Inlets and Outlets Collection. | -| [`GetIntraParticleCollisionStatistics`](#generated.RAStudy.GetIntraParticleCollisionStatistics)() | Get whether the Intra Particle Collision Statistics Module is enabled. | -| [`GetJointsData`](#generated.RAStudy.GetJointsData)() | Get the RAParticleJointsData object. | -| [`GetMaterialCollection`](#generated.RAStudy.GetMaterialCollection)() | Get the study's Material Collection. | -| [`GetMaterialsInteractionCollection`](#generated.RAStudy.GetMaterialsInteractionCollection)() | Deprecated: Use [`RAMaterialCollection.GetMaterialsInteractionCollection()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterialsInteractionCollection) instead. | -| [`GetMeshedParticlesUpscalingEnabled`](#generated.RAStudy.GetMeshedParticlesUpscalingEnabled)() | Get the Meshed Particles Upscaling value. | -| [`GetModuleCollection`](#generated.RAStudy.GetModuleCollection)() | Get the study's Module Collection. | -| [`GetMotionFrameSource`](#generated.RAStudy.GetMotionFrameSource)() | Get the study's Motion Frame Source. | -| [`GetParticleCollection`](#generated.RAStudy.GetParticleCollection)() | Get the study's Particle Collection. | -| [`GetParticleInput`](#generated.RAStudy.GetParticleInput)(input_name) | Get the particle input with the given name. | -| [`GetParticles`](#generated.RAStudy.GetParticles)() | Get the process that contains the simulated particles. | -| [`GetPhysics`](#generated.RAStudy.GetPhysics)() | Get the study's Physics object. | -| [`GetPointCloudCollection`](#generated.RAStudy.GetPointCloudCollection)() | Get the study's Point Cloud Collection. | -| [`GetProgress`](#generated.RAStudy.GetProgress)() | Get the current simulation progress [0.00, 100.00] or None if no simulation is running. | -| [`GetSimulatorRun`](#generated.RAStudy.GetSimulatorRun)() | Get the PrePost Scripting wrapper for simulation-related parameters. | -| [`GetSolver`](#generated.RAStudy.GetSolver)() | Synonym for [`GetSimulatorRun()`](#generated.RAStudy.GetSimulatorRun). | -| [`GetStatus`](#generated.RAStudy.GetStatus)([include_opengl_messages]) | Check the current Study status | -| [`GetSurfaceFromFilename`](#generated.RAStudy.GetSurfaceFromFilename)(filename) | Given a filename finds all imported geometries created from it. | -| [`GetTimeSet`](#generated.RAStudy.GetTimeSet)() | Get the study's timeset. | -| [`GetWallFromFilename`](#generated.RAStudy.GetWallFromFilename)(filename) | Given a filename finds all imported geometries created from it. | -| [`HasCalculatedHTC`](#generated.RAStudy.HasCalculatedHTC)() | Checks whether HTC is being calculated. | -| [`HasResults`](#generated.RAStudy.HasResults)() | Whether we have results from a previous simulation. | -| [`ImportSurface`](#generated.RAStudy.ImportSurface)(custom_filename[, ...]) | Import a custom surface file and create one or more corresponding geometries in the study. | -| [`ImportSystemCouplingWall`](#generated.RAStudy.ImportSystemCouplingWall)(custom_filename[, ...]) | Import a geometry file and create one or more corresponding geometries in the study. | -| [`ImportWall`](#generated.RAStudy.ImportWall)(custom_filename[, import_scale, ...]) | Import a geometry file and create one or more corresponding geometries in the study. | -| [`IsSimulating`](#generated.RAStudy.IsSimulating)() | Whether we're currently simulating something. | -| [`RefreshResults`](#generated.RAStudy.RefreshResults)() | Called to refresh the results we currently have from a simulation. | -| [`RemoveMaterialAndRelatedInteractions`](#generated.RAStudy.RemoveMaterialAndRelatedInteractions)(...) | Deprecated: Use `RemoveSolidMaterialAndRelatedInteractions()` instead. | -| [`RemoveSurface`](#generated.RAStudy.RemoveSurface)(filename) | Remove custom surfaces associated with the given filename. | -| [`RemoveWall`](#generated.RAStudy.RemoveWall)(filename) | Remove walls associated with the given filename. | -| [`ReplaceWallTriangles`](#generated.RAStudy.ReplaceWallTriangles)(new_filename[, ...]) | Replace the existing triangles of a geometry with new triangles. | -| [`SetCollectForcesForFemAnalysis`](#generated.RAStudy.SetCollectForcesForFemAnalysis)(value) | Enable the Boundary Collision Statistics modules and enable/disable the FEM Forces analysis | -| [`SetCustomerName`](#generated.RAStudy.SetCustomerName)(customer_name) | Change the study customer's name | -| [`SetDescription`](#generated.RAStudy.SetDescription)(description) | Change the study description | -| [`SetHTCCalculatorEnabled`](#generated.RAStudy.SetHTCCalculatorEnabled)(value) | Enable/disable the SPH HTC Calculator module. | -| [`SetIntraParticleCollisionStatistics`](#generated.RAStudy.SetIntraParticleCollisionStatistics)(value) | Enable/disable the Intra Particle Collision Statistics Module. | -| [`SetVariable`](#generated.RAStudy.SetVariable)(name, value) | Sets the values the given parametric variable | -| [`StartSimulation`](#generated.RAStudy.StartSimulation)([skip_summary, ...]) | Start the simulation. | -| [`StopSimulation`](#generated.RAStudy.StopSimulation)() | Stops a currently running simulation. | +|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [`CanResumeSimulation`](#generated.RAStudy.CanResumeSimulation)() | Whether the simulation can be resumed. | +| [`CreateFeedConveyor`](#generated.RAStudy.CreateFeedConveyor)() | Creates a new feed conveyor and add it to the project. | +| [`CreateOutlet`](#generated.RAStudy.CreateOutlet)(exit_point) | Create an outlet with the given exit point. | +| [`CreateParticle`](#generated.RAStudy.CreateParticle)() | Create a particle in the study with default values. | +| [`CreateParticleInlet`](#generated.RAStudy.CreateParticleInlet)(entry_point, particle) | Create a particle inlet with the given entry_point and particle. | +| [`CreateReceivingConveyor`](#generated.RAStudy.CreateReceivingConveyor)() | Creates a new receiving conveyor and add it to the project. | +| [`CreateVolumetricInlet`](#generated.RAStudy.CreateVolumetricInlet)([particle, name, ...]) | Creates a volumetric inlet with the given properties. | +| [`DeleteResults`](#generated.RAStudy.DeleteResults)() | Called to delete any results we currently have from a simulation. | +| [`ExtendSimulation`](#generated.RAStudy.ExtendSimulation)([extension_amount, time, ...]) | Extend the simulation: either its duration, the duration of an inlet in the study or the duration of a periodic motion frame. | +| [`GetAirFlow`](#generated.RAStudy.GetAirFlow)() | Get the RAAirFlow object (if applicable). | +| [`GetCFDCoupling`](#generated.RAStudy.GetCFDCoupling)() | Get the current CFD coupling object. | +| [`GetCalculations`](#generated.RAStudy.GetCalculations)() | Get the project's Calculations. | +| [`GetCollectForcesForFemAnalysis`](#generated.RAStudy.GetCollectForcesForFemAnalysis)() | Checks wheter the Collision Statistics modules are colecting FEM Forces for analysis | +| [`GetContactData`](#generated.RAStudy.GetContactData)() | Get the RAContactData object. | +| [`GetCustomerName`](#generated.RAStudy.GetCustomerName)() | Get the study customer name. | +| [`GetDescription`](#generated.RAStudy.GetDescription)() | Get the study description. | +| [`GetDomainSettings`](#generated.RAStudy.GetDomainSettings)() | Get the study's Domain Settings. | +| [`GetElementCurve`](#generated.RAStudy.GetElementCurve)(element_name, curve_name[, ...]) | Get the curve matching a given element name and curve name. | +| [`GetExportToolkit`](#generated.RAStudy.GetExportToolkit)() | Get a RAExportToolkit object related to this RAStudy. | +| [`GetFEMForcesAnalysisModules`](#generated.RAStudy.GetFEMForcesAnalysisModules)(module_collection) | Get the name and the FEM Forces property for all available Boundary Collision Statistics modules | +| [`GetGeometry`](#generated.RAStudy.GetGeometry)(geometry_name) | Get the geometry with the given name | +| [`GetGeometryCollection`](#generated.RAStudy.GetGeometryCollection)() | Get the study's Geometry Collection. | +| [`GetInletsOutletsCollection`](#generated.RAStudy.GetInletsOutletsCollection)() | Get the study's Inlets and Outlets Collection. | +| [`GetIntraParticleCollisionStatistics`](#generated.RAStudy.GetIntraParticleCollisionStatistics)() | Get whether the Intra Particle Collision Statistics Module is enabled. | +| [`GetJointsData`](#generated.RAStudy.GetJointsData)() | Get the RAParticleJointsData object. | +| [`GetMaterialCollection`](#generated.RAStudy.GetMaterialCollection)() | Get the study's Material Collection. | +| [`GetMaterialsInteractionCollection`](#generated.RAStudy.GetMaterialsInteractionCollection)() | Deprecated: Use [`RAMaterialCollection.GetMaterialsInteractionCollection()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterialsInteractionCollection) instead. | +| [`GetMeshedParticlesUpscalingEnabled`](#generated.RAStudy.GetMeshedParticlesUpscalingEnabled)() | Get the Meshed Particles Upscaling value. | +| [`GetModuleCollection`](#generated.RAStudy.GetModuleCollection)() | Get the study's Module Collection. | +| [`GetMotionFrameSource`](#generated.RAStudy.GetMotionFrameSource)() | Get the study's Motion Frame Source. | +| [`GetParticleCollection`](#generated.RAStudy.GetParticleCollection)() | Get the study's Particle Collection. | +| [`GetParticleInput`](#generated.RAStudy.GetParticleInput)(input_name) | Get the particle input with the given name. | +| [`GetParticles`](#generated.RAStudy.GetParticles)() | Get the process that contains the simulated particles. | +| [`GetPhysics`](#generated.RAStudy.GetPhysics)() | Get the study's Physics object. | +| [`GetPointCloudCollection`](#generated.RAStudy.GetPointCloudCollection)() | Get the study's Point Cloud Collection. | +| [`GetProgress`](#generated.RAStudy.GetProgress)() | Get the current simulation progress [0.00, 100.00] or None if no simulation is running. | +| [`GetSimulatorRun`](#generated.RAStudy.GetSimulatorRun)() | Get the PrePost Scripting wrapper for simulation-related parameters. | +| [`GetSolver`](#generated.RAStudy.GetSolver)() | Synonym for [`GetSimulatorRun()`](#generated.RAStudy.GetSimulatorRun). | +| [`GetStatus`](#generated.RAStudy.GetStatus)([include_opengl_messages]) | Check the current Study status | +| [`GetSurfaceFromFilename`](#generated.RAStudy.GetSurfaceFromFilename)(filename) | Given a filename finds all imported geometries created from it. | +| [`GetTimeSet`](#generated.RAStudy.GetTimeSet)() | Get the study's timeset. | +| [`GetWallFromFilename`](#generated.RAStudy.GetWallFromFilename)(filename) | Given a filename finds all imported geometries created from it. | +| [`HasCalculatedHTC`](#generated.RAStudy.HasCalculatedHTC)() | Checks whether HTC is being calculated. | +| [`HasResults`](#generated.RAStudy.HasResults)() | Whether we have results from a previous simulation. | +| [`ImportSurface`](#generated.RAStudy.ImportSurface)(custom_filename[, ...]) | Import a custom surface file and create one or more corresponding geometries in the study. | +| [`ImportSystemCouplingWall`](#generated.RAStudy.ImportSystemCouplingWall)(custom_filename[, ...]) | Import a geometry file and create one or more corresponding geometries in the study. | +| [`ImportWall`](#generated.RAStudy.ImportWall)(custom_filename[, import_scale, ...]) | Import a geometry file and create one or more corresponding geometries in the study. | +| [`IsSimulating`](#generated.RAStudy.IsSimulating)() | Whether we're currently simulating something. | +| [`RefreshResults`](#generated.RAStudy.RefreshResults)() | Called to refresh the results we currently have from a simulation. | +| [`RemoveSurface`](#generated.RAStudy.RemoveSurface)(filename) | Remove custom surfaces associated with the given filename. | +| [`RemoveWall`](#generated.RAStudy.RemoveWall)(filename) | Remove walls associated with the given filename. | +| [`ReplaceWallTriangles`](#generated.RAStudy.ReplaceWallTriangles)(new_filename[, ...]) | Replace the existing triangles of a geometry with new triangles. | +| [`SetCollectForcesForFemAnalysis`](#generated.RAStudy.SetCollectForcesForFemAnalysis)(value) | Enable the Boundary Collision Statistics modules and enable/disable the FEM Forces analysis | +| [`SetCustomerName`](#generated.RAStudy.SetCustomerName)(customer_name) | Change the study customer's name | +| [`SetDescription`](#generated.RAStudy.SetDescription)(description) | Change the study description | +| [`SetHTCCalculatorEnabled`](#generated.RAStudy.SetHTCCalculatorEnabled)(value) | Enable/disable the SPH HTC Calculator module. | +| [`SetIntraParticleCollisionStatistics`](#generated.RAStudy.SetIntraParticleCollisionStatistics)(value) | Enable/disable the Intra Particle Collision Statistics Module. | +| [`SetVariable`](#generated.RAStudy.SetVariable)(name, value) | Sets the values the given parametric variable | +| [`StartSimulation`](#generated.RAStudy.StartSimulation)([skip_summary, ...]) | Start the simulation. | +| [`StopSimulation`](#generated.RAStudy.StopSimulation)() | Stops a currently running simulation. | **Attributes:** @@ -117,34 +112,12 @@ various common actions related to simulations: Whether the simulation can be resumed. - - -#### CreateContinuousInjection(entry_point: RAFeedConveyor | RAInletGeometry, particle: RAParticle) - -Create a particle input with the given entry_point and particle. - -* **Parameters:** - * **entry_point** – The input’s entry point - either a FeedConveyor or an Inlet. - * **particle** – The particle that will enter through this input. - #### CreateFeedConveyor() Creates a new feed conveyor and add it to the project. - - -#### CreateInlet() - -Create a new inlet and add it to the project. - - - -#### CreateMaterialAndRelatedInteractions(material_name: str | None = None) - -Deprecated: Use `CreateSolidMaterialAndRelatedInteractions()` instead. - #### CreateOutlet(exit_point: RABaseGeometry) @@ -162,7 +135,7 @@ Create a particle in the study with default values. -#### CreateParticleInlet(entry_point: RAFeedConveyor | RAInletGeometry | RASurface, particle: RAParticle) +#### CreateParticleInlet(entry_point: RAFeedConveyor | RAInletGeometry | RARectangularSurface | RACircularSurface | RASurface, particle: RAParticle) Create a particle inlet with the given entry_point and particle. @@ -176,25 +149,9 @@ Create a particle inlet with the given entry_point and particle. Creates a new receiving conveyor and add it to the project. - - -#### CreateVolumeFill(particle: RAParticle | None = None, name: str | None = None, mass: float = 100.0, seed_coordinates: tuple[float, float, float] | None = None, geometries: list[str | RAWall] | None = None, use_geometries_to_compute: bool = False, box_center: tuple[float, float, float] | None = None, box_dimensions: tuple[float, float, float] | None = None) - -Creates a volume fill with the given properties. - -* **Parameters:** - * **name** – The name which will be used for the volume fill. - * **seed_coordinates** – A point (x, y, z) in meters that will be the reference to start the filling process. - * **geometries** – A list of names or RAWall selected in RAVolumetricInlet. The names or RAWall list must match the - existent geometries. - * **use_geometries_to_compute** – If true: the limits of the filling process will be the selected boundaries. - If false: a cube must be defined to be the limits of the filling process. - * **box_center** – A point (x, y, z) that will be the center of the limit cube. - * **dimensions** – The dimensions (length, width, height) of the limit cube. - -#### CreateVolumetricInlet(particle: RAParticle | None = None, name: str | None = None, mass: float = 100.0, seed_coordinates: tuple[float, float, float] | None = None, geometries: list[str | RAWall] | None = None, use_geometries_to_compute: bool = False, box_center: tuple[float, float, float] | None = None, box_dimensions: tuple[float, float, float] | None = None) +#### CreateVolumetricInlet(particle: RAParticle | None = None, name: str | None = None, mass: float = 100.0, seed_coordinates: tuple[float, float, float] | None = None, geometries: list[str | RAWall] | None = None, use_geometries_to_compute: bool = False, box_center: tuple[float, float, float] | None = None, box_dimensions: tuple[float, float, float] | None = None, use_box_center_as_seed_point=False) Creates a volumetric inlet with the given properties. @@ -208,6 +165,7 @@ Creates a volumetric inlet with the given properties. * **box_center** – A point (x, y, z) that will be the center of the limit cube. * **dimensions** – The dimensions (length, width, height) of the limit cube. * **box_dimensions** – The dimensions (lenght, width, height) of the limit cube. + * **use_box_center_as_seed_point** – If true, the seed point will be set to the box center. @@ -551,12 +509,6 @@ Whether we’re currently simulating something. Called to refresh the results we currently have from a simulation. - - -#### RemoveMaterialAndRelatedInteractions(material_or_name: RASolidMaterial | str) - -Deprecated: Use `RemoveSolidMaterialAndRelatedInteractions()` instead. - #### RemoveSurface(filename: str) @@ -662,8 +614,7 @@ DeleteResults() first. presented to the user (True). * **delete_results** (*bool*) – True if the simulation results should be deleted, False otherwise. If there are no simulation results, this flag is ignored - * **non_blocking** (*bool*) – If True, start the simulation asynchronously. If not on batch mode, it will prevent - the UI to show the global progress bar. + * **non_blocking** (*bool*) – If True, start the simulation asynchronously. Only works in headless mode (raises an error if otherwise). :return bool : Returns True if the simulation has started successfully, False otherwise. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RASurface.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RASurface.md index bfce27b622..8497f9a2bd 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RASurface.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RASurface.md @@ -42,12 +42,16 @@ Rocky API “Surface” model. | [`GetCurveNames`](#generated.RASurface.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RASurface.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RASurface.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RASurface.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RASurface.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RASurface.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RASurface.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RASurface.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RASurface.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RASurface.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RASurface.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetInvertNormal`](#generated.RASurface.GetInvertNormal)() | Get the value of "Invert Normal". | | [`GetMeshColoring`](#generated.RASurface.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | +| [`GetMotionFrame`](#generated.RASurface.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RASurface.GetNumberOfCells)([time_step]) | Get the total number of cells. | | [`GetNumberOfNodes`](#generated.RASurface.GetNumberOfNodes)([time_step]) | Get the total number of nodes (vertices). | | [`GetNumpyCurve`](#generated.RASurface.GetNumpyCurve)(curve_name[, unit, realization]) | Returns a curve as a tuple of numpy arrays (time, property) for the given element and name. | @@ -62,6 +66,7 @@ Rocky API “Surface” model. | [`GetTimeStep`](#generated.RASurface.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RASurface.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | | [`GetTranslation`](#generated.RASurface.GetTranslation)([unit]) | Get the value of "Translation". | +| [`GetVertices`](#generated.RASurface.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RASurface.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`HasMotionFrame`](#generated.RASurface.HasMotionFrame)() | Whether the geometry is linked to a motion frame. | | [`IsCellActive`](#generated.RASurface.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -74,6 +79,7 @@ Rocky API “Surface” model. | [`RemoveProcess`](#generated.RASurface.RemoveProcess)() | Removes the process from the project. | | [`SetCurrentTimeStep`](#generated.RASurface.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetInvertNormal`](#generated.RASurface.SetInvertNormal)(value) | Set the value of "Invert Normal". | +| [`SetMotionFrame`](#generated.RASurface.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | | [`SetOrientation`](#generated.RASurface.SetOrientation)(rotation[, unit]) | The rotation is the angles in x, y and z of the rotation in the given unit. | | [`SetOrientationFromAngleAndVector`](#generated.RASurface.SetOrientationFromAngleAndVector)(angle, vector) | The rotation uses the angle and a vector, using unit and changes the orientation mode to Angle and Vector. | | [`SetOrientationFromAngles`](#generated.RASurface.SetOrientationFromAngles)(rotation[, unit, ...]) | The rotation is the angles in x, y and z of the rotation. | @@ -138,7 +144,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -150,7 +156,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -217,30 +223,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -433,99 +437,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -534,39 +526,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -600,22 +588,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -657,25 +643,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -697,13 +723,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -711,22 +735,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) - -Get a list of the available grid functions for this grid. +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -736,7 +747,7 @@ Get the value of “Invert Normal”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -747,33 +758,36 @@ Get the RAMeshColoring related to the current object and a window. **RockyApiError** – If window is not a str or KAWorkspaceWindow. Additionally, raises an error if no window is found or no coloring for the given item exists. + + +#### GetMotionFrame() + +* **Returns:** + The motion frame set in the process, or None if no motion is set. + -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -835,8 +849,6 @@ Get the value of “Pivot Point”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -874,16 +886,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -896,16 +906,29 @@ Get the value of “Translation”. * **Parameters:** **unit** – The unit for the returned values. If no unit is provided, the returned values will be in “m”. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -920,31 +943,29 @@ Whether the geometry is linked to a motion frame. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -954,12 +975,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1024,6 +1045,15 @@ Set the value of “Invert Normal”. * **Parameters:** **value** – The value to set. + + +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) + +Assign a Motion Frame to the process. + +* **Parameters:** + **motion_frame** – Either the API object or its name. + #### SetOrientation(rotation: tuple[float, float, float], unit: str = 'dega') diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RASurfaceUserProcess.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RASurfaceUserProcess.md index ec12e1e1ce..10284ea6f9 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RASurfaceUserProcess.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RASurfaceUserProcess.md @@ -41,10 +41,13 @@ generally aren't instantiated by the user). --> | [`GetCurveNames`](#generated.RASurfaceUserProcess.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RASurfaceUserProcess.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RASurfaceUserProcess.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RASurfaceUserProcess.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RASurfaceUserProcess.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RASurfaceUserProcess.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RASurfaceUserProcess.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RASurfaceUserProcess.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RASurfaceUserProcess.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RASurfaceUserProcess.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RASurfaceUserProcess.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMeshColoring`](#generated.RASurfaceUserProcess.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMotionFrame`](#generated.RASurfaceUserProcess.GetMotionFrame)() | | | [`GetNumberOfCells`](#generated.RASurfaceUserProcess.GetNumberOfCells)([time_step]) | Get the total number of cells. | @@ -61,6 +64,7 @@ generally aren't instantiated by the user). --> | [`GetTimeStatistics`](#generated.RASurfaceUserProcess.GetTimeStatistics)() | Get the object responsible for handling time-statistics grid functions for this process. | | [`GetTimeStep`](#generated.RASurfaceUserProcess.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | | [`GetTopologyShape`](#generated.RASurfaceUserProcess.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | +| [`GetVertices`](#generated.RASurfaceUserProcess.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RASurfaceUserProcess.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`IsCellActive`](#generated.RASurfaceUserProcess.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | | [`IterCellVertices`](#generated.RASurfaceUserProcess.IterCellVertices)(cell[, time_step]) | Iterate on the vertices of active grid cells at the given time. | @@ -138,7 +142,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -150,7 +154,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -217,30 +221,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -433,99 +435,87 @@ Edit a custom property saved in the database. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -534,39 +524,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -600,16 +586,14 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) @@ -624,7 +608,7 @@ Get an array with the volume of each cell. -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -666,25 +650,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -706,13 +730,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -720,26 +742,13 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -759,31 +768,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -860,8 +865,6 @@ Get the value of “Scale”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -899,59 +902,68 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -961,12 +973,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1056,7 +1068,7 @@ Sets the current time step. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RASystemCouplingWall.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RASystemCouplingWall.md index f92dc51229..71807244cc 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RASystemCouplingWall.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RASystemCouplingWall.md @@ -35,6 +35,7 @@ Rocky API “System Coupling Wall” model. | [`GetActivesArray`](#generated.RASystemCouplingWall.GetActivesArray)([time_step]) | Get an array representing the cells' "active" status. | | [`GetAvailableMaterials`](#generated.RASystemCouplingWall.GetAvailableMaterials)() | Get all available Materials. | | [`GetBoundingBox`](#generated.RASystemCouplingWall.GetBoundingBox)([unit, time_step]) | Get the element's bounding box. | +| [`GetCapillaryFrictionCoefficient`](#generated.RASystemCouplingWall.GetCapillaryFrictionCoefficient)() | Get the value of "Capillary Friction Coefficient". | | [`GetCellAreaAsArray`](#generated.RASystemCouplingWall.GetCellAreaAsArray)([time_step]) | Get an array containing the area of each cell. | | [`GetCellCenterAsArray`](#generated.RASystemCouplingWall.GetCellCenterAsArray)([time_step]) | Get an array containing the center coordinates of each cell. | | [`GetCellDzAsArray`](#generated.RASystemCouplingWall.GetCellDzAsArray)([time_step]) | Get an array containing the thickness (in Z) of each cell. | @@ -47,10 +48,13 @@ Rocky API “System Coupling Wall” model. | [`GetCurveNames`](#generated.RASystemCouplingWall.GetCurveNames)([simulation_name]) | @param simulation_name: unicode | | [`GetCurveNamesAssociation`](#generated.RASystemCouplingWall.GetCurveNamesAssociation)([simulation_name]) | Get this element's curve names. | | [`GetElementCurve`](#generated.RASystemCouplingWall.GetElementCurve)(element_name, curve_name[, ...]) | Return the curves for the given element and name. | +| [`GetFacePositions`](#generated.RASystemCouplingWall.GetFacePositions)([time_step]) | Get the index of the faces. | +| [`GetFaceVertices`](#generated.RASystemCouplingWall.GetFaceVertices)([time_step]) | Get the index of the vertices for all faces. | | [`GetGeometryQuantity`](#generated.RASystemCouplingWall.GetGeometryQuantity)() | Get the quantity corresponding to the grid's geometry. | +| [`GetGeometryTransform`](#generated.RASystemCouplingWall.GetGeometryTransform)([time_step]) | Get the geometry transform for the grid at the given time step. | | [`GetGeometryUnit`](#generated.RASystemCouplingWall.GetGeometryUnit)() | Get the grid's geometry's unit. | | [`GetGridFunction`](#generated.RASystemCouplingWall.GetGridFunction)(grid_function_name[, ...]) | Gets a grid function given its name. | -| [`GetGridFunctionNames`](#generated.RASystemCouplingWall.GetGridFunctionNames)([translated, context]) | Get a list of the available grid functions for this grid. | +| [`GetGridFunctionNames`](#generated.RASystemCouplingWall.GetGridFunctionNames)([translated, context]) | Overridden to filter out deprecated property names. | | [`GetMaterial`](#generated.RASystemCouplingWall.GetMaterial)() | Get the "Material". | | [`GetMeshColoring`](#generated.RASystemCouplingWall.GetMeshColoring)(window) | Get the RAMeshColoring related to the current object and a window. | | [`GetMotionFrame`](#generated.RASystemCouplingWall.GetMotionFrame)() | | @@ -68,6 +72,7 @@ Rocky API “System Coupling Wall” model. | [`GetTopologyShape`](#generated.RASystemCouplingWall.GetTopologyShape)([time_step]) | Get the shape of the topology (similar to the shape of numpy arrays). | | [`GetTriangleSize`](#generated.RASystemCouplingWall.GetTriangleSize)([unit]) | Get the value of "Triangle Size". | | [`GetValidSphBoundaryTypeValues`](#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues)() | Get a list of all possible values for "Sph Boundary Type". | +| [`GetVertices`](#generated.RASystemCouplingWall.GetVertices)([time_step]) | Get the geometry vertices of the grid at the given time step. | | [`HasGridFunction`](#generated.RASystemCouplingWall.HasGridFunction)(grid_function_name) | Whether the grid has the given grid function. | | [`HasMotionFrame`](#generated.RASystemCouplingWall.HasMotionFrame)() | Whether the geometry is linked to a motion frame. | | [`IsCellActive`](#generated.RASystemCouplingWall.IsCellActive)(i, j, k[, time_step]) | Checks if the given cell is active or not | @@ -80,6 +85,7 @@ Rocky API “System Coupling Wall” model. | [`RemoveCustomProperty`](#generated.RASystemCouplingWall.RemoveCustomProperty)(name) | Remove the property from the database :param name: The name of the property to be removed. | | [`RemoveOutputVariable`](#generated.RASystemCouplingWall.RemoveOutputVariable)(variable_name) | Removes some output variable. | | [`RemoveProcess`](#generated.RASystemCouplingWall.RemoveProcess)() | Removes the process from the project. | +| [`SetCapillaryFrictionCoefficient`](#generated.RASystemCouplingWall.SetCapillaryFrictionCoefficient)(value) | Set the value of "Capillary Friction Coefficient". | | [`SetCurrentTimeStep`](#generated.RASystemCouplingWall.SetCurrentTimeStep)(time_step) | Sets the current time step. | | [`SetMaterial`](#generated.RASystemCouplingWall.SetMaterial)(value) | Set the "Material". | | [`SetMotionFrame`](#generated.RASystemCouplingWall.SetMotionFrame)(motion_frame) | Assign a Motion Frame to the process. | @@ -146,7 +152,7 @@ Add a custom property to the database -#### AddGridFunction(grid_function_name, grid_function, unit='', location='cell', realization='user_generated', time_step=None) +#### AddGridFunction(grid_function_name, grid_function, unit: str | IQuantity = '', location: str = 'cell', realization: str = 'user_generated', time_step: str | int | ITimeStep | None = None) Adds a grid function to the grid. @@ -158,7 +164,7 @@ Adds a grid function to the grid. * **location** (*unicode*) – The location of the grid function (currently only ‘cell’ is accepted). * **realization** (*unicode*) – The realization used to identify the grid function among other grid functions. If None, this information is ignored. - * **time_step** (*None* *,* *unicode* *,* *ITimeStep* *or* *int*) – if None if given a static grid function will be created otherwise a transient grid + * **time_step** – if None if given a static grid function will be created otherwise a transient grid function is created and the given array associated with this time-step #### SEE ALSO @@ -225,30 +231,28 @@ Used to create an output variable based on a curve which doesn’t change at eac -#### CreateGridFunction(values, location='cell', time_step='current') +#### CreateGridFunction(values: list[float] | ndarray, location: str = 'cell', time_step: str | int | ITimeStep = 'current') Create a grid function from the given values, location and time-step. * **Parameters:** - * **values** (*list* *(**double* *) or* *numpy array*) – The values of the grid function to be added. - * **time_step** - -#### SEE ALSO -KAContextDependentElement.GetTimeStep + * **values** – The values of the grid function to be added. + * **time_step** – if None if given a static grid function will be created otherwise a transient grid + function is created and the given array associated with this time-step +* **Returns:** + The created grid function. -#### CreateGridFunctionArrayOnCells(time_step='current') +#### CreateGridFunctionArrayOnCells(time_step: str | int | ITimeStep = 'current') Creates a numpy array with the number of elements based on the cells and returns it. A different time may be specified to create the grid function based on a different time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to create the array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** Returns a numpy float32 array with the number of elements equal to the number of cells. @@ -465,16 +469,14 @@ Set the value of “Thermal Coupling Type” to True. -#### GetActivesArray(time_step='current') +#### GetActivesArray(time_step: str | int | ITimeStep = 'current') Get an array representing the cells’ “active” status. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the actives array or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy array * **Returns:** Returns a numpy array with booleans where True means the cell is active and False means it’s not active. @@ -491,83 +493,79 @@ Get all available Materials. -#### GetBoundingBox(unit=None, time_step='current') +#### GetBoundingBox(unit: str | None = None, time_step: str | int | ITimeStep = 'current') Get the element’s bounding box. * **Parameters:** - * **unit** (*unicode*) – The unit in which the bounding box should be gotten (by default it uses the same + * **unit** – The unit in which the bounding box should be gotten (by default it uses the same unit of the geometry). - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the bounding box or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple(tuple(float, float, float), tuple(float, float, float)) * **Returns:** - THe minimum and maximum geometry coordinates of the grid or None if the + The minimum and maximum geometry coordinates of the grid or None if the time step is not available at the requested time. + + +#### GetCapillaryFrictionCoefficient() + +Get the value of “Capillary Friction Coefficient”. + -#### GetCellAreaAsArray(time_step='current') +#### GetCellAreaAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the area of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell area (the unit will be the geometry unit \*\* 2) -#### GetCellCenterAsArray(time_step='current') +#### GetCellCenterAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the center coordinates of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell center or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell center coordinates (each element will be a point to the center of the cell). -#### GetCellDzAsArray(time_step='current') +#### GetCellDzAsArray(time_step: str | int | ITimeStep = 'current') Get an array containing the thickness (in Z) of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell dz or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with cell thicknesses computed in the Z direction. -#### GetCellFromIJK(i, j, k, time_step='current') +#### GetCellFromIJK(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Creates a grid cell handle from the current I, J, K indexes * **Parameters:** - * **i** (*int*) – The topological I cell index - * **j** (*int*) – The topological J cell index - * **k** (*int*) – The topological K cell index - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **i** – The topological I cell index + * **j** – The topological J cell index + * **k** – The topological K cell index + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell from the i, j, k or an int identifying the time step index to be used based on the global time set -* **Return type:** - int or None * **Returns:** Returns the cell handle to be used for the given I, J, K indexes. Or None if the given I, J and K indexes are invalid or refer to an inactive cell @@ -576,39 +574,35 @@ Creates a grid cell handle from the current I, J, K indexes -#### GetCellIJK(cell_handle, time_step='current') +#### GetCellIJK(cell_handle: int, time_step: str | int | ITimeStep = 'current') Converts the given cell handle to it’s I, J, K indexes * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the i, j, k from the cell. or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple( i, j, k ) * **Returns:** The cell I, J, K indexes -#### GetCellNumberOfVertices(cell, time_step='current') +#### GetCellNumberOfVertices(cell: int, time_step: str | int | ITimeStep = 'current') Get an array containing the number of vertices of each cell. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of vertices for the given cell or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of vertices on the given cell -#### GetCellPointsAsFunction(time_step='current') +#### GetCellPointsAsFunction(time_step: str | int | ITimeStep = 'current') Get a function for the points (vertices) of each cell. @@ -642,22 +636,20 @@ for vertex in grid.IterCellVertices(cell): -#### GetCellVolumeAsArray(time_step='current') +#### GetCellVolumeAsArray(time_step: str | int | ITimeStep = 'current') Get an array with the volume of each cell. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the cell volume or an int identifying the time step index to be used based on the global time set -* **Return type:** - numpy.array * **Returns:** An array with the cell volume (the unit will be the geometry unit \*\* 3) -#### GetCurve(curve_name, simulation_name=None, realization=None, time_step=None) +#### GetCurve(curve_name, simulation_name=None, realization=None, time_step: str | int | ITimeStep | None = None) Override base class method to check for a request of a grid function statistic. @@ -699,25 +691,65 @@ Return the curves for the given element and name. * **realization** (*unicode*) – An additional keyword to identify the curve realization * **time_step** (*TimeStep*) – For transient curves a time-step must be given. + + +#### GetFacePositions(time_step: str | int | ITimeStep = 'current') + +Get the index of the faces. Use this in conjunction with GetFaceVertices to obtain +the index of vertices in each face. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the face index of the grid at the given time step. + + + +#### GetFaceVertices(time_step: str | int | ITimeStep = 'current') + +Get the index of the vertices for all faces. Use this in conjunction with GetFacePositions +to obtain the index of vertices in each face. The index is related to the vertices obtained +via GetVertices. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices index of the grid at the given time step. + #### GetGeometryQuantity() Get the quantity corresponding to the grid’s geometry. -* **Return type:** - IQuantity * **Returns:** The grid geometry quantity + + +#### GetGeometryTransform(time_step: str | int | ITimeStep = 'current') + +Get the geometry transform for the grid at the given time step. This should be used in +conjunction with GetVertices to obtain the transformed vertices of the grid. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + The geometry transform as a tuple of (translation, rotation) or None if the + object has no motion frame associated to it. + #### GetGeometryUnit() Get the grid’s geometry’s unit. -* **Return type:** - unicode * **Returns:** The unit for the grid geometry @@ -739,13 +771,11 @@ grid.GetGridFunction('Temperature').GetArray(unit='degC', time_step=time_set[10] if it’s used without a time parameter, it’ll get the array at the current application time. * **Parameters:** - * **grid_function_name** (*unicode*) – The name of the grid function to be gotten in this grid. - * **simulation_name** (*unicode*) – An optional parameter for defining the simulation to get the grid function from. - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the + * **grid_function_name** – The name of the grid function to be gotten in this grid. + * **simulation_name** – An optional parameter for defining the simulation to get the grid function from. + * **translated** – If False, the internal names of the grid functions will be returned, otherwise, the name returned will be the translated name (based on the settings chosen on how to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). -* **Return type:** - KAGridFunction * **Returns:** The grid function found * **Raises:** @@ -753,22 +783,9 @@ if it’s used without a time parameter, it’ll get the array at the current ap -#### GetGridFunctionNames(translated=False, context=None) +#### GetGridFunctionNames(translated: bool = False, context: str | None = None) -Get a list of the available grid functions for this grid. - -* **Parameters:** - * **translated** (*bool*) – If False, the internal names of the grid functions will be returned, otherwise, the - name returned will be the translated name (based on the settings chosen on how - to see grid functions – i.e.: Cognitive, ECLIPSE, IMEX). - * **context** ( *'all'* *,* *'static'* *or* *'transient'*) – Which names should be returned - ‘all’ all grid function names - ‘static’ only the static grid function names - ‘transient’ only the transient grid function names -* **Return type:** - list(unicode) -* **Returns:** - Returns a list with the grid functions available. +Overridden to filter out deprecated property names. @@ -781,7 +798,7 @@ Get the “Material”. -#### GetMeshColoring(window: str | type[KAWorkspaceWindow]) +#### GetMeshColoring(window: str | KAWorkspaceWindow) Get the RAMeshColoring related to the current object and a window. @@ -801,31 +818,27 @@ Get the RAMeshColoring related to the current object and a window. -#### GetNumberOfCells(time_step='current') +#### GetNumberOfCells(time_step: str | int | ITimeStep = 'current') Get the total number of cells. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of cells -#### GetNumberOfNodes(time_step='current') +#### GetNumberOfNodes(time_step: str | int | ITimeStep = 'current') Get the total number of nodes (vertices). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the number of cells or an int identifying the time step index to be used based on the global time set -* **Return type:** - int * **Returns:** The total number of nodes/vertices @@ -883,8 +896,6 @@ Get the value of “Thermal Coupling Type Enabled”. Get the list of time-steps associated to the grid. -* **Return type:** - ITimeSet * **Returns:** The list of time-steps associated to the grid @@ -922,16 +933,14 @@ Get the timestep corresponding to the given time. -#### GetTopologyShape(time_step='current') +#### GetTopologyShape(time_step: str | int | ITimeStep = 'current') Get the shape of the topology (similar to the shape of numpy arrays). * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get the topology shape or an int identifying the time step index to be used based on the global time set -* **Return type:** - tuple of ints * **Returns:** The grid shape as a tuple of the grid size in each topological dimension. @@ -953,16 +962,29 @@ Get a list of all possible values for “Sph Boundary Type”. * **Returns:** The returned list is [‘free_slip’, ‘no_slip_laminar’, ‘no_slip_turbulent’]. + + +#### GetVertices(time_step: str | int | ITimeStep = 'current') + +Get the geometry vertices of the grid at the given time step. This should be used in +conjunction with GetGeometryTransform to obtain the transformed vertices of the grid +at a given time_step, otherwise it may return the vertices without any transformation. + +* **Parameters:** + **time_step** – Either a ‘current’ string with meaning the current time step + or an ITimeStep identifying the time to get the geometry transform + or an int identifying the time step index to be used based on the global time set +* **Returns:** + a numpy array with the vertices of the grid at the given time step. + -#### HasGridFunction(grid_function_name) +#### HasGridFunction(grid_function_name: str) Whether the grid has the given grid function. * **Parameters:** - **grid_function_name** (*unicode*) – The name of the grid function to be checked. -* **Return type:** - bool + **grid_function_name** – The name of the grid function to be checked. * **Returns:** Returns True if the grid function exists and False otherwise. @@ -977,19 +999,17 @@ Whether the geometry is linked to a motion frame. -#### IsCellActive(i, j, k, time_step='current') +#### IsCellActive(i: int, j: int, k: int, time_step: str | int | ITimeStep = 'current') Checks if the given cell is active or not -@param i, j, k: int +@param i, j, k: : The cell i, j, k * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to get if the cell is active or an int identifying the time step index to be used based on the global time set -* **Return type:** - bool * **Returns:** True if the cell is active @@ -1007,13 +1027,13 @@ Check if the “Thermal Coupling Type” is enabled. -#### IterCellVertices(cell, time_step='current') +#### IterCellVertices(cell: int, time_step: str | int | ITimeStep = 'current') Iterate on the vertices of active grid cells at the given time. * **Parameters:** - * **cell_handle** (*int*) – The cell handle - * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + * **cell_handle** – The cell handle + * **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the vertices of a cell or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1023,12 +1043,12 @@ Iterate on the vertices of active grid cells at the given time. -#### IterCells(time_step='current') +#### IterCells(time_step: str | int | ITimeStep = 'current') Iterate on the active grid cells at the given time. * **Parameters:** - **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – Either a ‘current’ string with meaning the current time step + **time_step** – Either a ‘current’ string with meaning the current time step or an ITimeStep identifying the time to iterate the cells or an int identifying the time step index to be used based on the global time set * **Return type:** @@ -1075,6 +1095,15 @@ Removes some output variable. Removes the process from the project. + + +#### SetCapillaryFrictionCoefficient(value: str | float) + +Set the value of “Capillary Friction Coefficient”. + +* **Parameters:** + **value** – The value to set. This value can be an expression with input variables or float type. + #### SetCurrentTimeStep(time_step) @@ -1095,7 +1124,7 @@ Set the “Material”. -#### SetMotionFrame(motion_frame: [RAMotionFrame](RAMotionFrame.md#generated.RAMotionFrame) | str | None) +#### SetMotionFrame(motion_frame: RAMotionFrame | str | None) Assign a Motion Frame to the process. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RATimePlotWindow.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RATimePlotWindow.md new file mode 100644 index 0000000000..1728585fa2 --- /dev/null +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RATimePlotWindow.md @@ -0,0 +1,391 @@ + + +# RATimePlotWindow + + + + + + +### *class* RATimePlotWindow + +**Methods:** + +| Name | Description | +|--------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| [`ClearCurves`](#generated.RATimePlotWindow.ClearCurves)() | Remove all curve from the window | +| [`CloseWindow`](#generated.RATimePlotWindow.CloseWindow)() | Removes this window from the application. | +| [`CreateMark`](#generated.RATimePlotWindow.CreateMark)([image_property, statistic_name, ...]) | Creates a mark in the plot window with the given parameters. | +| [`CreateTimeMark`](#generated.RATimePlotWindow.CreateTimeMark)(time_step[, message]) | Creates a mark in the given time with the given message. | +| [`ExportCurves`](#generated.RATimePlotWindow.ExportCurves)(filename[, curve_names, ...]) | Export a set of curves to a CSV file. | +| [`GetAxisLimits`](#generated.RATimePlotWindow.GetAxisLimits)(curve_name[, unit]) | Return the minimum and maximum values on the axis associated with the given curve name | +| [`GetAxisUnit`](#generated.RATimePlotWindow.GetAxisUnit)(curve_name) | Get the unit for the axis associated with the given curve | +| [`GetCurvesDescription`](#generated.RATimePlotWindow.GetCurvesDescription)() | | +| [`GetTable`](#generated.RATimePlotWindow.GetTable)() | | +| [`GetTimeStep`](#generated.RATimePlotWindow.GetTimeStep)(time_step[, accept_global]) | Get the timestep corresponding to the given time. | +| [`GetTitle`](#generated.RATimePlotWindow.GetTitle)() | | +| [`InvalidateWindow`](#generated.RATimePlotWindow.InvalidateWindow)() | Invalidates the window and request a redraw. | +| [`Resize`](#generated.RATimePlotWindow.Resize)(width, height) | Changes the size of the plot. | +| [`SetAxisByProperty`](#generated.RATimePlotWindow.SetAxisByProperty)() | Change the axis behavior so all curves of the same property will share the same axis. | +| [`SetAxisByQuantity`](#generated.RATimePlotWindow.SetAxisByQuantity)() | Change the axis behavior so all curves with the same quantity will share the same axis. | +| [`SetAxisLimits`](#generated.RATimePlotWindow.SetAxisLimits)(curve_name, min_value, max_value) | Change the limits for axis associated to the given curve_name | +| [`SetAxisUnit`](#generated.RATimePlotWindow.SetAxisUnit)(curve_name, unit) | Change the unit for the axis associated with the given curve | +| [`SetBottomAxisUnit`](#generated.RATimePlotWindow.SetBottomAxisUnit)(unit) | Change the unit of the bottom X axis | +| [`SetColoringStrategyByElement`](#generated.RATimePlotWindow.SetColoringStrategyByElement)() | Change the visual of the curves so all curves associated with an element will share the same visual appearance. | +| [`SetColoringStrategyByProperty`](#generated.RATimePlotWindow.SetColoringStrategyByProperty)() | Change the visual of the curves so all curves associated from the same simulation will share the same visual appearance. | +| [`SetColoringStrategyByStudy`](#generated.RATimePlotWindow.SetColoringStrategyByStudy)() | Change the visual of the curves so all curves associated from the same simulation will share the same visual appearance. | +| [`SetCurrentTimeStep`](#generated.RATimePlotWindow.SetCurrentTimeStep)(time_step) | Sets the current time step. | +| [`SetSelectedWindow`](#generated.RATimePlotWindow.SetSelectedWindow)([window_name]) | Sets the given window as the currently selected window. | +| [`SetStickEnabled`](#generated.RATimePlotWindow.SetStickEnabled)([enabled]) | | +| [`ShowCurve`](#generated.RATimePlotWindow.ShowCurve)(element_name, curve_name[, unit, ...]) | Shows a curve in a Time-plot window. | +| [`ShowGridFunctionStatisticsCurve`](#generated.RATimePlotWindow.ShowGridFunctionStatisticsCurve)(...[, ...]) | Shows a grid function statistics curve in a Time-plot window. | +| [`ShowMaximized`](#generated.RATimePlotWindow.ShowMaximized)() | Maximize the window, making it fill the entire screen space. | +| [`ShowMinimized`](#generated.RATimePlotWindow.ShowMinimized)() | Minimize the window, effectively hiding it from view and placing it in the taskbar | +| [`ShowNormal`](#generated.RATimePlotWindow.ShowNormal)() | Restore the window to its normal size, which is neither minimized nor maximized. | +| [`Snapshot`](#generated.RATimePlotWindow.Snapshot)(filename[, width, height, ...]) | Take a snapshot from the window content and save it in the filename given. | + +**Attributes:** + +| Name | +| -------------------------------------------- | +| [`app`](#generated.RATimePlotWindow.app) | + + + +#### ClearCurves() + +Remove all curve from the window + + + +#### CloseWindow() + +Removes this window from the application. + + + +#### CreateMark(image_property: str | None = None, statistic_name: str | None = None, image_value: float | None = None, image_unit: str | None = None, domain_value: float | None = None, domain_unit: str | None = None, message: str = '') + +Creates a mark in the plot window with the given parameters. + +* **Parameters:** + * **image_property** – The name of the property curve image to be used for the mark. + * **statistic_name** – The name of the statistic to be used for the image property. Possible values are: + ‘average’, ‘min’, ‘max’, ‘sum’, ‘sum squared’, ‘variance’, ‘std deviation’, and ‘cell’. + * **image_value** – The value of the image property to be used for the mark. + * **image_unit** – The unit of the image value (if not specified, the unit of the curve will be used). + * **domain_value** – The value of the domain to be used for the mark. + * **domain_unit** – The unit of the domain value (if not specified, the unit of the bottom axis will be used). + * **message** – The label of the mark. +* **Returns:** + A KAPlotMark object representing the created mark. + + + +#### CreateTimeMark(time_step, message=None) + +Creates a mark in the given time with the given message. + +* **Parameters:** + * **time_step** (*unicode* *,* *ITimeStep* *,* *int* *or* *tuple*) – + + Either a string with + : ’current’ identifying the current time step + + or an ITimeStep identifying the time to get the limits. + + or an int identifying the time step index to be used based on the global time set . + + or a tuple containing the values for the year, month, day, hour. minute and second. + : (e.g (2009, 10, 01) maps to Oct 01, 2009, and (2009, 10, 01, 23, 12, 01) maps to the + same day but it also specifies the hour (23:12:01). + * **message** (*unicode*) – The mark label + + + +#### ExportCurves(filename, curve_names=None, merge_domain=[], interpolate_values=False) + +Export a set of curves to a CSV file. + +* **Parameters:** + * **filename** (*str*) – The name of the csv file to be generated. + * **curve_names** (*list* *of* *str* *or* *None*) – The names of the curves to export. If None is passed, all curves in the plot will be exported. + * **merge_domain** (*list* *of* *str*) – Defines the name of the curves whose domain should be taken into account on making the + merge. + * **interpolate_values** (*bool*) – True if the curves’ values should be interpolated. + + + +#### GetAxisLimits(curve_name, unit=None) + +Return the minimum and maximum values on the axis associated with the given curve name + +* **Parameters:** + * **curve_name** (*unicode*) – The name of the curve + * **unit** (*unicode*) – The unit in which the values should be returned + (if not specified no conversion is made). +* **Return type:** + tuple(float, float) +* **Returns:** + The min and max values + + + +#### GetAxisUnit(curve_name) + +Get the unit for the axis associated with the given curve + +* **Parameters:** + **curve_name** (*unicode*) – The name of the curve +* **Return type:** + unicode +* **Returns:** + The unit of the axis + + + +#### GetCurvesDescription() + +* **Return type:** + list(tuple(unicode, unicode, unicode)) +* **Returns:** + Returns a list of description for each in the plot. + Each curve is described by the property name, element name and simulation name + + + +#### GetTable() + +* **Return type:** + KATable +* **Returns:** + The table representation of the plot window + + + +#### GetTimeStep(time_step, accept_global=False) + +Get the timestep corresponding to the given time. + +* **Parameters:** + * **time_step** (*unicode* *,* *ITimeStep* *or* *int*) – + + Either a string with + : ’current’ identifying the current time step + ‘global’ identifying that the global limits should be gotten + (note that if accept_global=False and ‘global’ is passed, an error is raised). + + or an ITimeStep identifying the time to get the limits + + or an int identifying the time step index to be used based on the global time set + * **accept_global** (*bool*) – If True, a global time step is accepted (and returns None), otherwise, an error is + raised if ‘global’ is passed. +* **Return type:** + ITimeStep +* **Returns:** + Returns the time step to be used or None if accept_global == True and the time + step passed is ‘global’. + + + +#### GetTitle() + +* **Return type:** + unicode +* **Returns:** + The plot window title + + + +#### InvalidateWindow() + +Invalidates the window and request a redraw. + + + +#### Resize(width, height) + +Changes the size of the plot. + +* **Parameters:** + * **width** (*int*) – The width to be set for the plot. + * **height** (*int*) – The height to be set for the plot. + + + +#### SetAxisByProperty() + +Change the axis behavior so all curves of the same property will share the same axis. + + + +#### SetAxisByQuantity() + +Change the axis behavior so all curves with the same quantity will share the same axis. + + + +#### SetAxisLimits(curve_name, min_value, max_value, unit=None) + +Change the limits for axis associated to the given curve_name + +* **Parameters:** + * **curve_name** (*unicode*) – The name of the curve to select the axis + * **min_value** (*float*) – The minimum value + * **max_value** (*float*) – The maximum value + * **unit** (*unicode*) – The unit in which the min and max are given + (if not specified no conversion is made). +* **Return type:** + bool +* **Returns:** + Whether it was possible to set the axis limits + + + +#### SetAxisUnit(curve_name, unit) + +Change the unit for the axis associated with the given curve + +* **Parameters:** + * **curve_name** (*unicode*) – The name of the curve + * **unit** (*unit*) – The unit to be set + + + +#### SetBottomAxisUnit(unit) + +Change the unit of the bottom X axis + +* **Parameters:** + **unit** (*unicode*) – The new axis unit + + + +#### SetColoringStrategyByElement() + +Change the visual of the curves so all curves associated with an element will share the +same visual appearance. + + + +#### SetColoringStrategyByProperty() + +Change the visual of the curves so all curves associated from the same simulation +will share the same visual appearance. + + + +#### SetColoringStrategyByStudy() + +Change the visual of the curves so all curves associated from the same simulation +will share the same visual appearance. + + + +#### SetCurrentTimeStep(time_step) + +Sets the current time step. + +* **Parameters:** + **time_step** (*ITimeStep*) – The time step to be considered the ‘current’ time step. + + + +#### SetSelectedWindow(window_name=None) + +Sets the given window as the currently selected window. + +* **Parameters:** + **window_name** (*unicode*) – The name of the window that should be selected (if not passed, the window which has + this method called is selected). + + + +#### SetStickEnabled(enabled=True) + +* **Parameters:** + **bool_enabled** + + + +#### ShowCurve(element_name, curve_name, unit=None, window_name=None) + +Shows a curve in a Time-plot window. + +* **Parameters:** + * **element_name** (*unicode*) – The name of the element that has the curve. + * **curve_name** (*unicode*) – The name of the curve to be shown. + * **unit** (*unicode*) – The unit in which the curve should be shown (if not specified, given by the simulator). + * **window_name** (*unicode*) – The name of the window in which the curve should be shown (if not given, the current + window will be used) +* **Return type:** + bool +* **Returns:** + Return True if a curve was actually shown and False otherwise (i.e.: window could not + be found, element not available). + + + +#### ShowGridFunctionStatisticsCurve(element_name, grid_function_name, statistic_name='average', unit=None, window_name=None) + +Shows a grid function statistics curve in a Time-plot window. + +* **Parameters:** + * **element_name** (*unicode*) – The name of the element that has the curve. + * **grid_function_name** (*unicode*) – The name of the Grid Function to be shown. + * **statistic_name** (*unicode*) – The name of the Statistic to use. Possible values are: + ‘Average’, ‘Min’, ‘Max’, ‘Sum’, ‘Sum Squared’, ‘Variance’, ‘STD Deviation’, and ‘Cell’ + * **unit** (*unicode*) – The unit in which the curve should be shown (if not specified, given by the simulator). + * **window_name** (*unicode*) – The name of the window in which the curve should be shown (if not given, the current + window will be used) +* **Return bool:** + Return True if a curve was actually shown and False otherwise (i.e.: window could not + be found, element not available). + + + +#### ShowMaximized() + +Maximize the window, making it fill the entire screen space. + + + +#### ShowMinimized() + +Minimize the window, effectively hiding it from view and placing it in the taskbar + + + +#### ShowNormal() + +Restore the window to its normal size, which is neither minimized nor maximized. + + + +#### Snapshot(filename, width=None, height=None, magnification=None, keep_aspect_ratio=None) + +Take a snapshot from the window content and save it in the filename given. + +* **Parameters:** + * **filename** (*unicode*) – The file name to save the snapshot. + .. note:: the filename must contain the extension. e.g.: ‘../snapshot.png’ + * **width** (*int*) – The snapshot width (only used for plots, not 3d windows). + .. note:: the current window width is used if it is None + * **height** (*int*) – The snapshot height (only used for plots, not 3d windows). + .. note:: the current window height is used if it is None + * **magnification** (*int*) – An int value to multiply the snapshot size. + .. note:: if this parameter is specified, the width and height parameters are ignored. + * **keep_aspect_ratio** (*bool*) – Only used for plots, not 3d windows. + If True the current plot size is scaled to a rectangle as large as possible inside a + given rectangle (defined by the size given), keeping the aspect ratio. + + + +#### *property* app + +* **Return type:** + KAApplication +* **Returns:** + The application diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeRangeFilter.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeRangeFilter.md index 797f41589a..9d4573d0dd 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeRangeFilter.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeRangeFilter.md @@ -15,8 +15,9 @@ Rocky PrePost Scripting wrapper to manipulate Time Range Filter. **Methods:** -| [`GetDomainRange`](#generated.RATimeRangeFilter.GetDomainRange)() | Get the value of "Domain Range". | +| Name | Description | |-----------------------------------------------------------------------------------------|-------------------------------------------------------| +| [`GetDomainRange`](#generated.RATimeRangeFilter.GetDomainRange)() | Get the value of "Domain Range". | | [`GetFinal`](#generated.RATimeRangeFilter.GetFinal)([unit]) | Get the value of "Final". | | [`GetInitial`](#generated.RATimeRangeFilter.GetInitial)([unit]) | Get the value of "Initial". | | [`GetValidDomainRangeValues`](#generated.RATimeRangeFilter.GetValidDomainRangeValues)() | Get a list of all possible values for "Domain Range". | diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeSeriesRotation.md b/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeSeriesRotation.md index 042379a6e5..69181cac82 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeSeriesRotation.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/RATimeSeriesRotation.md @@ -25,8 +25,9 @@ time_series_rotation = motion_1.GetTypeObject() **Methods:** -| [`ImportTimeSeriesMotion`](#generated.RATimeSeriesRotation.ImportTimeSeriesMotion)(file_path) | Generate the Time Series Motion Frame described on the contents of the file. | +| Name | Description | |-------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| [`ImportTimeSeriesMotion`](#generated.RATimeSeriesRotation.ImportTimeSeriesMotion)(file_path) | Generate the Time Series Motion Frame described on the contents of the file. | diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/basic-usage.md b/2026R1/rocky-prepost-scripting-manual-26-r1/basic-usage.md index 419c91bb2b..f51369f600 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/basic-usage.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/basic-usage.md @@ -10,15 +10,15 @@ This page provides a basic guide/tutorial of the PrePost Scripting from the poin your project and exploring simulation results. For a more complete reference to the classes available in scripting see the [Class Reference](prepost-scripting-reference.md). -> **Note:** Not all Rocky scripting capabilities are currently documented in this scripting +> :memo: **Note:** Not all Rocky scripting capabilities are currently documented in this scripting > manual. There are additional classes and functions available for some Rocky post-processing > features that are documented in the Rocky code itself. These can be accessed via the Python Shell. --- -> **Note:** If the project already has simulation results, then using these API methods to +> :memo: **Note:** If the project already has simulation results, then using these API methods to > change parameters that affect those results might cause errors. In these cases, it might be > necessary to call study.DeleteResults() before making changes. (See also the topic “I cannot > change my setup parameters during processing” in the Rocky User Manual.) --- -> **Important:** Some input parameters are blocked in Rocky UI after saving a project for restart. These parameters can be changed by the user through PrePost Scripting (via script or Python Shell). However, changing blocked parameters trough PrePost Scripting is not advisable as it may cause problems in your simulation. +> :warning: **Important:** Some input parameters are blocked in Rocky UI after saving a project for restart. These parameters can be changed by the user through PrePost Scripting (via script or Python Shell). However, changing blocked parameters trough PrePost Scripting is not advisable as it may cause problems in your simulation. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/changelog.md b/2026R1/rocky-prepost-scripting-manual-26-r1/changelog.md index dd5a59744a..68949cf7ab 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/changelog.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/changelog.md @@ -1,6 +1,6 @@ -# Release notes for 2025 R2 +# Release notes for 2026 R1 @@ -10,110 +10,256 @@ ### New Methods -* [`RASolidMaterial`](RASolidMaterial.md) - * [`GetBulkSolidFraction`](RASolidMaterial.md#generated.RASolidMaterial.GetBulkSolidFraction) - * [`SetBulkSolidFraction`](RASolidMaterial.md#generated.RASolidMaterial.SetBulkSolidFraction) -* `RockyApiApplication` - * `DuplicateWindow` -* [`RACubeGroup`](RACubeGroup.md) - * [`AddProcess`](RACubeGroup.md#generated.RACubeGroup.AddProcess) - Add a new cube in the group using the given process as source. - * [`SetCenter`](RACubeGroup.md#generated.RACubeGroup.SetCenter) - * [`GetCenterAfterMovement`](RACubeGroup.md#generated.RACubeGroup.GetCenterAfterMovement) - * [`GetSize`](RACubeGroup.md#generated.RACubeGroup.GetSize) - * [`SetSize`](RACubeGroup.md#generated.RACubeGroup.SetSize) - * [`SetRotation`](RACubeGroup.md#generated.RACubeGroup.SetRotation) -* [`RACylinderGroup`](RACylinderGroup.md) - * [`AddProcess`](RACylinderGroup.md#generated.RACylinderGroup.AddProcess) - Add a new cube in the group using the given process as source. - * [`GetCenter`](RACylinderGroup.md#generated.RACylinderGroup.GetCenter) - * [`SetCenter`](RACylinderGroup.md#generated.RACylinderGroup.SetCenter) - * [`GetCenterAfterMovement`](RACylinderGroup.md#generated.RACylinderGroup.GetCenterAfterMovement) - * [`GetSize`](RACylinderGroup.md#generated.RACylinderGroup.GetSize) - * [`SetSize`](RACylinderGroup.md#generated.RACylinderGroup.SetSize) - * [`SetRotation`](RACylinderGroup.md#generated.RACylinderGroup.SetRotation) - * [`GetRotation`](RACylinderGroup.md#generated.RACylinderGroup.GetRotation) - * [`SetInternalFactor`](RACylinderGroup.md#generated.RACylinderGroup.SetInternalFactor) - * [`GetInternalFactor`](RACylinderGroup.md#generated.RACylinderGroup.GetInternalFactor) - * [`SetInitialAngle`](RACylinderGroup.md#generated.RACylinderGroup.SetInitialAngle) - * [`GetInitialAngle`](RACylinderGroup.md#generated.RACylinderGroup.GetInitialAngle) - * [`SetFinalAngle`](RACylinderGroup.md#generated.RACylinderGroup.SetFinalAngle) - * [`GetFinalAngle`](RACylinderGroup.md#generated.RACylinderGroup.GetFinalAngle) -* [`RAVolumetricInlet`](RAVolumetricInlet.md) - * [`GetOrientation`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientation) - * [`SetOrientation`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientation) - * [`SetOrientationFromAngles`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngles) - * [`GetOrientationFromAngles`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngles) - * [`SetOrientationFromAngleAndVector`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromAngleAndVector) - * [`GetOrientationFromAngleAndVector`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromAngleAndVector) - * [`SetOrientationFromBasisVector`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetOrientationFromBasisVector) - * [`GetOrientationFromBasisVector`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetOrientationFromBasisVector) +* [`RAPlaneGroup`](RAPlaneGroup.md) + * [`AddProcess`](RAPlaneGroup.md#generated.RAPlaneGroup.AddProcess) - Adds a new plane in the group using the given process as source. + * [`GetType`](RAPlaneGroup.md#generated.RAPlaneGroup.GetType) + * [`SetType`](RAPlaneGroup.md#generated.RAPlaneGroup.SetType) + * [`GetMode`](RAPlaneGroup.md#generated.RAPlaneGroup.GetMode) + * [`SetMode`](RAPlaneGroup.md#generated.RAPlaneGroup.SetMode) + * [`GetOrigin`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrigin) + * [`SetOrigin`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrigin) +* [`RAPointCloud`](RAPointCloud.md) + * [`GetSearchCutOffDistance`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOffDistance) + * [`SetSearchCutOffDistance`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOffDistance) +* [`RADomainSettings`](RADomainSettings.md) + * [`ResetDomainToGeometriesLimits`](RADomainSettings.md#generated.RADomainSettings.ResetDomainToGeometriesLimits) * [`RASPHSettings`](RASPHSettings.md) - * [`GetShepardFilterOnDensityEnabled`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) - * [`SetShepardFilterOnDensityEnabled`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) - * [`EnableShepardFilterOnDensity`](RASPHSettings.md#generated.RASPHSettings.EnableShepardFilterOnDensity) - * [`DisableShepardFilterOnDensity`](RASPHSettings.md#generated.RASPHSettings.DisableShepardFilterOnDensity) - * [`IsShepardFilterOnDensityEnabled`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) - * [`GetShepardFilterOnPressureEnabled`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) - * [`SetShepardFilterOnPressureEnabled`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) - * [`EnableShepardFilterOnPressure`](RASPHSettings.md#generated.RASPHSettings.EnableShepardFilterOnPressure) - * [`DisableShepardFilterOnPressure`](RASPHSettings.md#generated.RASPHSettings.DisableShepardFilterOnPressure) - * [`IsShepardFilterOnPressureEnabled`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) -* [`RAParticle`](RAParticle.md) - * [`GetAllowSelfContacts`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) - * [`SetAllowSelfContacts`](RAParticle.md#generated.RAParticle.SetAllowSelfContacts) - * [`GetDeformationModel`](RAParticle.md#generated.RAParticle.GetDeformationModel) - * [`SetDeformationModel`](RAParticle.md#generated.RAParticle.SetDeformationModel) - * [`GetValidDeformationModelValues`](RAParticle.md#generated.RAParticle.GetValidDeformationModelValues) - * [`GetInternalFriction`](RAParticle.md#generated.RAParticle.GetInternalFriction) - * [`SetInternalFriction`](RAParticle.md#generated.RAParticle.SetInternalFriction) - * [`GetPlasticLimit`](RAParticle.md#generated.RAParticle.GetPlasticLimit) - * [`SetPlasticLimit`](RAParticle.md#generated.RAParticle.SetPlasticLimit) + * [`GetViscousForceIntegration`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceIntegration) + * [`SetViscousForceIntegration`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceIntegration) + * [`GetValidViscousForceIntegrationValues`](RASPHSettings.md#generated.RASPHSettings.GetValidViscousForceIntegrationValues) + * [`GetViscousForceMaximumNumberOfIterations`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceMaximumNumberOfIterations) + * [`SetViscousForceMaximumNumberOfIterations`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceMaximumNumberOfIterations) + * [`GetViscousForceRelativeErrorTolerance`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceRelativeErrorTolerance) + * [`SetViscousForceRelativeErrorTolerance`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceRelativeErrorTolerance) + * [`GetViscousForceUnderRelaxationFactor`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceUnderRelaxationFactor) + * [`SetViscousForceUnderRelaxationFactor`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceUnderRelaxationFactor) + * [`GetIncompressibilityRelaxationFactor`](RASPHSettings.md#generated.RASPHSettings.GetIncompressibilityRelaxationFactor) + * [`SetIncompressibilityRelaxationFactor`](RASPHSettings.md#generated.RASPHSettings.SetIncompressibilityRelaxationFactor) + * [`GetRelaxedIncompressibilityConstraintEnabled`](RASPHSettings.md#generated.RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled) + * [`SetRelaxedIncompressibilityConstraintEnabled`](RASPHSettings.md#generated.RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled) + * [`EnableRelaxedIncompressibilityConstraint`](RASPHSettings.md#generated.RASPHSettings.EnableRelaxedIncompressibilityConstraint) + * [`DisableRelaxedIncompressibilityConstraint`](RASPHSettings.md#generated.RASPHSettings.DisableRelaxedIncompressibilityConstraint) + * [`IsRelaxedIncompressibilityConstraintEnabled`](RASPHSettings.md#generated.RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled) +* [`RAVolumetricInlet`](RAVolumetricInlet.md) + * [`GetUseBoxCenterAsSeedPoint`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseBoxCenterAsSeedPoint) + * [`SetUseBoxCenterAsSeedPoint`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseBoxCenterAsSeedPoint) + * [`EnableUseBoxCenterAsSeedPoint`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnableUseBoxCenterAsSeedPoint) + * [`DisableUseBoxCenterAsSeedPoint`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisableUseBoxCenterAsSeedPoint) + * [`IsUseBoxCenterAsSeedPointEnabled`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsUseBoxCenterAsSeedPointEnabled) + * [`AddParticle`](RAVolumetricInlet.md#generated.RAVolumetricInlet.AddParticle) + * [`RemoveParticle`](RAVolumetricInlet.md#generated.RAVolumetricInlet.RemoveParticle) +* [`RAMotionFrame`](RAMotionFrame.md) + * [`AddFreeBodyTranslationMotion`](RAMotionFrame.md#generated.RAMotionFrame.AddFreeBodyTranslationMotion) + * [`AddFreeBodyRotationMotion`](RAMotionFrame.md#generated.RAMotionFrame.AddFreeBodyRotationMotion) +* [`RAWall`](RAWall.md) + * [`GetCapillaryFrictionCoefficient`](RAWall.md#generated.RAWall.GetCapillaryFrictionCoefficient) + * [`SetCapillaryFrictionCoefficient`](RAWall.md#generated.RAWall.SetCapillaryFrictionCoefficient) + * [`GetMotionFrame`](RAWall.md#generated.RAWall.GetMotionFrame) + * [`SetMotionFrame`](RAWall.md#generated.RAWall.SetMotionFrame) +* [`RASystemCouplingWall`](RASystemCouplingWall.md) + * [`GetCapillaryFrictionCoefficient`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCapillaryFrictionCoefficient) + * [`SetCapillaryFrictionCoefficient`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCapillaryFrictionCoefficient) +* [`RAReceivingConveyor`](RAReceivingConveyor.md) + * [`GetCapillaryFrictionCoefficient`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCapillaryFrictionCoefficient) + * [`SetCapillaryFrictionCoefficient`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCapillaryFrictionCoefficient) +* [`RAFeedConveyor`](RAFeedConveyor.md) + * [`GetCapillaryFrictionCoefficient`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCapillaryFrictionCoefficient) + * [`SetCapillaryFrictionCoefficient`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCapillaryFrictionCoefficient) +* [`RAFluidInlet`](RAFluidInlet.md) + * [`GetInjectionDuration`](RAFluidInlet.md#generated.RAFluidInlet.GetInjectionDuration) + * [`SetInjectionDuration`](RAFluidInlet.md#generated.RAFluidInlet.SetInjectionDuration) + * [`GetPeriodic`](RAFluidInlet.md#generated.RAFluidInlet.GetPeriodic) + * [`SetPeriodic`](RAFluidInlet.md#generated.RAFluidInlet.SetPeriodic) + * [`EnablePeriodic`](RAFluidInlet.md#generated.RAFluidInlet.EnablePeriodic) + * [`DisablePeriodic`](RAFluidInlet.md#generated.RAFluidInlet.DisablePeriodic) + * [`IsPeriodicEnabled`](RAFluidInlet.md#generated.RAFluidInlet.IsPeriodicEnabled) + * [`GetPeriod`](RAFluidInlet.md#generated.RAFluidInlet.GetPeriod) + * [`SetPeriod`](RAFluidInlet.md#generated.RAFluidInlet.SetPeriod) * [`RASimulatorRun`](RASimulatorRun.md) - * [`GetIterDefAccur`](RASimulatorRun.md#generated.RASimulatorRun.GetIterDefAccur) - * [`SetIterDefAccur`](RASimulatorRun.md#generated.RASimulatorRun.SetIterDefAccur) - * [`GetLengthDefAccur`](RASimulatorRun.md#generated.RASimulatorRun.GetLengthDefAccur) - * [`SetLengthDefAccur`](RASimulatorRun.md#generated.RASimulatorRun.SetLengthDefAccur) - * [`GetMassMatrixDef`](RASimulatorRun.md#generated.RASimulatorRun.GetMassMatrixDef) - * [`SetMassMatrixDef`](RASimulatorRun.md#generated.RASimulatorRun.SetMassMatrixDef) - * [`GetValidMassMatrixDefValues`](RASimulatorRun.md#generated.RASimulatorRun.GetValidMassMatrixDefValues) - * [`GetMinVolumeFactor`](RASimulatorRun.md#generated.RASimulatorRun.GetMinVolumeFactor) - * [`SetMinVolumeFactor`](RASimulatorRun.md#generated.RASimulatorRun.SetMinVolumeFactor) - * [`GetNiterDefMax`](RASimulatorRun.md#generated.RASimulatorRun.GetNiterDefMax) - * [`SetNiterDefMax`](RASimulatorRun.md#generated.RASimulatorRun.SetNiterDefMax) - * [`GetOverrelaxationCoefficient`](RASimulatorRun.md#generated.RASimulatorRun.GetOverrelaxationCoefficient) - * [`SetOverrelaxationCoefficient`](RASimulatorRun.md#generated.RASimulatorRun.SetOverrelaxationCoefficient) - * [`GetJointElasticRatio`](RASimulatorRun.md#generated.RASimulatorRun.GetJointElasticRatio) - * [`SetJointElasticRatio`](RASimulatorRun.md#generated.RASimulatorRun.SetJointElasticRatio) + * [`GetProcessingUnit`](RASimulatorRun.md#generated.RASimulatorRun.GetProcessingUnit) + * [`SetProcessingUnit`](RASimulatorRun.md#generated.RASimulatorRun.SetProcessingUnit) +* [`RASphSettings`]() + * [`GetEnabled`]() + * [`SetEnabled`]() +* [`RAParticleInlet`](RAParticleInlet.md) + * [`AddParticle`](RAParticleInlet.md#generated.RAParticleInlet.AddParticle) + * [`RemoveParticle`](RAParticleInlet.md#generated.RAParticleInlet.RemoveParticle) +* [`RACircularSurface`](RACircularSurface.md) + * [`GetMotionFrame`](RACircularSurface.md#generated.RACircularSurface.GetMotionFrame) + * [`SetMotionFrame`](RACircularSurface.md#generated.RACircularSurface.SetMotionFrame) +* [`RACoupledWall`](RACoupledWall.md) + * [`GetMotionFrame`](RACoupledWall.md#generated.RACoupledWall.GetMotionFrame) + * [`SetMotionFrame`](RACoupledWall.md#generated.RACoupledWall.SetMotionFrame) +* [`RACustomInput`](RACustomInput.md) + * [`GetMotionFrame`](RACustomInput.md#generated.RACustomInput.GetMotionFrame) + * [`SetMotionFrame`](RACustomInput.md#generated.RACustomInput.SetMotionFrame) +* [`RARectangularSurface`](RARectangularSurface.md) + * [`GetMotionFrame`](RARectangularSurface.md#generated.RARectangularSurface.GetMotionFrame) + * [`SetMotionFrame`](RARectangularSurface.md#generated.RARectangularSurface.SetMotionFrame) +* [`RASurface`](RASurface.md) + * [`GetMotionFrame`](RASurface.md#generated.RASurface.GetMotionFrame) + * [`SetMotionFrame`](RASurface.md#generated.RASurface.SetMotionFrame) +* [`RAProject`](RAProject.md) + * [`HasUnsavedChanges`](RAProject.md#generated.RAProject.HasUnsavedChanges) ### New Classes -* [`RACubeGroup`](RACubeGroup.md) - Wraps a series of user cubes. -* [`RACylinderGroup`](RACylinderGroup.md) - Wraps a series of user cylinders. +* [`RAPlaneGroup`](RAPlaneGroup.md) - Wraps a series of plane user processes. ## Changed +* [`RAStudy`](RAStudy.md) + * [`CreateVolumetricInlet`](RAStudy.md#generated.RAStudy.CreateVolumetricInlet) - Added `use_box_center_as_seed_point` argument. +* [`RAMaterialCollection`](RAMaterialCollection.md) + * [`AddSolidMaterial`](RAMaterialCollection.md#generated.RAMaterialCollection.AddSolidMaterial) - Added `material_name` argument. + * [`AddFluidMaterial`](RAMaterialCollection.md#generated.RAMaterialCollection.AddFluidMaterial) - Added `material_name` argument. + ## Deprecated -* [`RAMaterialCollection`](RAMaterialCollection.md) - * [`GetBulkSolidFraction`](RAMaterialCollection.md#generated.RAMaterialCollection.GetBulkSolidFraction) - * [`SetBulkSolidFraction`](RAMaterialCollection.md#generated.RAMaterialCollection.SetBulkSolidFraction) -* `RockyApiApplication` - * `Duplicate3DWindow` * [`RASimulatorRun`](RASimulatorRun.md) - * [`GetUseDpmBlockingEffectForSinglePhaseSimulations`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) - * [`SetUseDpmBlockingEffectForSinglePhaseSimulations`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) - * [`EnableDpmBlockingEffectForSinglePhaseSimulations`](RASimulatorRun.md#generated.RASimulatorRun.EnableDpmBlockingEffectForSinglePhaseSimulations) - * [`DisableDpmBlockingEffectForSinglePhaseSimulations`](RASimulatorRun.md#generated.RASimulatorRun.DisableDpmBlockingEffectForSinglePhaseSimulations) - * [`IsDpmBlockingEffectForSinglePhaseSimulationsEnabled`](RASimulatorRun.md#generated.RASimulatorRun.IsDpmBlockingEffectForSinglePhaseSimulationsEnabled) -* [`RAStudy`](RAStudy.md) - * [`CreateVolumetricInlet`](RAStudy.md#generated.RAStudy.CreateVolumetricInlet) - `particle` and `mass` arguments are deprecated. - * [`GetAirFlow`](RAStudy.md#generated.RAStudy.GetAirFlow) - Use `GetCFDCoupling` to obtain the coupling object. + * [`GetSimulationTarget`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationTarget) + * [`SetSimulationTarget`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationTarget) ## Removed + +* [`RAAdditionalFeatures`]() + * [`GetMeshedParticlesUpscalingEnabled`]() - Use `RAStudy.GetMeshedParticlesUpscaling` instead. + * [`SetMeshedParticlesUpscalingEnabled`]() - Use `RAStudy.SetMeshedParticlesUpscalingEnabled` instead. +* [`RACalculations`](RACalculations.md) + * [`CreateSelectionTagging`](RACalculations.md#generated.RACalculations.CreateSelectionTagging) - Use `CreateTagging` instead. +* [`RACFDCoupling`](RACFDCoupling.md) + * [`SetupAirFlow`](RACFDCoupling.md#generated.RACFDCoupling.SetupAirFlow) - Use `SetupOneWayLBM` instead. + * [`GetAirFlow`](RACFDCoupling.md#generated.RACFDCoupling.GetAirFlow) - Use `GetOneWayLBM` instead. + * [`SetupFluentOneWaySteadyState`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentOneWaySteadyState) - Use `SetupOneWayFluent` instead. + * [`SetupOneWayFluentSteadyState`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayFluentSteadyState) - Use `SetupOneWayFluent` instead. + * [`SetupFluentTwoWay`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentTwoWay) - Use `SetupTwoWayFluent` instead. + * [`SetupConstantOneWay`](RACFDCoupling.md#generated.RACFDCoupling.SetupConstantOneWay) - Use `SetupOneWayConstant` instead. + * [`SetupCFDConstantOneWayCouplingProcess`](RACFDCoupling.md#generated.RACFDCoupling.SetupCFDConstantOneWayCouplingProcess) - Use `SetupOneWayConstant` instead. +* [`RADomainSettings`](RADomainSettings.md) + * [`GetBoundariesDirections`](RADomainSettings.md#generated.RADomainSettings.GetBoundariesDirections) - Use `GetCartesianPeriodicDirections` instead. + * [`SetBoundariesDirections`](RADomainSettings.md#generated.RADomainSettings.SetBoundariesDirections) - Use `SetCartesianPeriodicDirections` instead. + * [`GetValidBoundariesDirectionsValues`](RADomainSettings.md#generated.RADomainSettings.GetValidBoundariesDirectionsValues) - Use `GetValidCartesianPeriodicDirectionsValues` instead. +* [`RAFluentTwoWayCoupling`](RAFluentTwoWayCoupling.md) + * [`GetMaximumVolumeFractionTarget`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFractionTarget) - Use `GetSolidsMaximumVolumeFractionTarget` instead. + * [`SetMaximumVolumeFractionTarget`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFractionTarget) - Use `SetSolidsMaximumVolumeFractionTarget` instead. +* [`RAFluidMaterial`](RAFluidMaterial.md) + * [`GetSoundSpeed`](RAFluidMaterial.md#generated.RAFluidMaterial.GetSoundSpeed) - Use `RASPHSettings.GetSoundSpeed` instead. + * [`SetSoundSpeed`](RAFluidMaterial.md#generated.RAFluidMaterial.SetSoundSpeed) - Use `RASPHSettings.SetSoundSpeed` instead. +* [`RAGeometryCollection`](RAGeometryCollection.md) + * [`IterInputGeometries`](RAGeometryCollection.md#generated.RAGeometryCollection.IterInputGeometries) - Use `IterInletGeometries` instead. +* [`RAInletsOutletsCollection`](RAInletsOutletsCollection.md) + * [`AddContinuousInjection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddContinuousInjection) - Use `AddParticleInlet` instead. + * [`AddVolumeFill`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddVolumeFill) - Use `AddVolumetricInlet` instead. +* [`RAMaterialManager`]() + * [`CreateMaterialAndRelatedInteractions`]() - Use `CreateSolidMaterialAndRelatedInteractions` instead. + * [`RemoveMaterialAndRelatedInteractions`]() - Use `RemoveSolidMaterialAndRelatedInteractions` instead. +* [`RAParticleInletProperties`](RAParticleInletProperties.md) + * [`GetTonnage`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetTonnage) - Use `GetMassFlowRate` instead. + * [`SetTonnage`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetTonnage) - Use `SetMassFlowRate` instead. +* [`RAParticleInlet`](RAParticleInlet.md) + * [`GetTonnageList`](RAParticleInlet.md#generated.RAParticleInlet.GetTonnageList) - Use `GetInputPropertiesList` instead. + * [`EnablePeriodicDischarge`](RAParticleInlet.md#generated.RAParticleInlet.EnablePeriodicDischarge) - Use `EnablePeriodic` instead. + * [`DisablePeriodicDischarge`](RAParticleInlet.md#generated.RAParticleInlet.DisablePeriodicDischarge) - Use `DisablePeriodic` instead. + * [`IsPeriodicDischargeEnabled`](RAParticleInlet.md#generated.RAParticleInlet.IsPeriodicDischargeEnabled) - Use `IsPeriodicEnabled` instead. + * [`GetPeriodicDischarge`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriodicDischarge) - Use `GetPeriodic` instead. + * [`SetPeriodicDischarge`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriodicDischarge) - Use `SetPeriodic` instead. + * [`GetDischargeTime`](RAParticleInlet.md#generated.RAParticleInlet.GetDischargeTime) - Use `GetInjectionDuration` instead. + * [`SetDischargeTime`](RAParticleInlet.md#generated.RAParticleInlet.SetDischargeTime) - Use `SetInjectionDuration` instead. +* [`RAParticle`](RAParticle.md) + * [`ImportFiberFromTXT`](RAParticle.md#generated.RAParticle.ImportFiberFromTXT) - Use `ImportCustomFiber` instead. + * [`GetRotationAngle`](RAParticle.md#generated.RAParticle.GetRotationAngle) - Use `GetOrientationFromAngleAndVector` instead. + * [`SetRotationAngle`](RAParticle.md#generated.RAParticle.SetRotationAngle) - Use `SetOrientationFromAngleAndVector` instead. + * [`GetRotationVector`](RAParticle.md#generated.RAParticle.GetRotationVector) - Use `GetOrientationFromAngleAndVector` instead. + * [`SetRotationVector`](RAParticle.md#generated.RAParticle.SetRotationVector) - Use `SetOrientationFromAngleAndVector` instead. +* [`RACubeProcess`](RACubeProcess.md) + * [`GetCubeCenter`](RACubeProcess.md#generated.RACubeProcess.GetCubeCenter) - Use `GetCenter` instead. + * [`SetCubeCenter`](RACubeProcess.md#generated.RACubeProcess.SetCubeCenter) - Use `SetCenter` instead. + * [`GetCubeMagnitude`](RACubeProcess.md#generated.RACubeProcess.GetCubeMagnitude) - Use `GetSize` instead. + * [`SetCubeMagnitude`](RACubeProcess.md#generated.RACubeProcess.SetCubeMagnitude) - Use `SetSize` instead. + * [`GetCubeRotation`](RACubeProcess.md#generated.RACubeProcess.GetCubeRotation) - Use `GetRotation` instead. + * [`SetCubeRotation`](RACubeProcess.md#generated.RACubeProcess.SetCubeRotation) - Use `SetRotation` instead. +* [`RAPlaneProcess`](RAPlaneProcess.md) + * [`GetPlaneOrigin`](RAPlaneProcess.md#generated.RAPlaneProcess.GetPlaneOrigin) - Use `GetOrigin` instead. + * [`SetPlaneOrigin`](RAPlaneProcess.md#generated.RAPlaneProcess.SetPlaneOrigin) - Use `SetOrigin` instead. + * [`GetNormal`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNormal) - Use `GetRelativeRotationVector` instead. + * [`GetPlaneNormal`](RAPlaneProcess.md#generated.RAPlaneProcess.GetPlaneNormal) - Use `GetRelativeRotationVector` instead. + * [`SetNormal`](RAPlaneProcess.md#generated.RAPlaneProcess.SetNormal) - Use `SetRelativeRotationVector` instead. + * [`SetPlaneNormal`](RAPlaneProcess.md#generated.RAPlaneProcess.SetPlaneNormal) - Use `SetRelativeRotationVector` instead. +* [`RATrajectoryProcess`](RATrajectoryProcess.md) + * [`SetStartingTimeStep`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetStartingTimeStep) - Use `SetStartingTime` instead. + * [`GetStartingTimeStep`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetStartingTimeStep) - Use `GetStartingTime` instead. + * [`SetNumberOfTimeSteps`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetNumberOfTimeSteps) - Use `SetNumberOfIntervals` instead. + * [`GetNumberOfTimeSteps`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfTimeSteps) - Use `GetNumberOfIntervals` instead. +* [`RAPolyhedronProcess`](RAPolyhedronProcess.md) + * [`GetSize`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetSize) - Use `GetScale` instead. + * [`SetSize`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetSize) - Use `SetScale` instead. + * [`GetRotation`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetRotation) - Use `GetOrientation` instead. + * [`SetRotation`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetRotation) - Use `SetOrientation` instead. +* [`RASurfaceUserProcess`](RASurfaceUserProcess.md) + * [`GetRotation`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetRotation) - Use `GetOrientation` instead. + * [`SetRotation`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetRotation) - Use `SetOrientation` instead. + * [`GetSize`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetSize) - Use `GetScale` instead. + * [`SetSize`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.SetSize) - Use `SetScale` instead. +* [`RASimulatorRun`](RASimulatorRun.md) + * [`GetWearGeometryUpdateFrequency`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateFrequency) - Use `GetWearGeometryUpdateInterval` instead. + * [`SetWearGeometryUpdateFrequency`](RASimulatorRun.md#generated.RASimulatorRun.SetWearGeometryUpdateFrequency) - Use `SetWearGeometryUpdateInterval` instead. + * [`SetCollectForcesForFemAnalysis`](RASimulatorRun.md#generated.RASimulatorRun.SetCollectForcesForFemAnalysis) - Use `RAStudy.SetCollectForcesForFemAnalysis` instead. + * [`GetCollectForcesForFemAnalysis`](RASimulatorRun.md#generated.RASimulatorRun.GetCollectForcesForFemAnalysis) - Use `RAStudy.GetCollectForcesForFemAnalysis` instead. + * [`GetWearEnergySpectraBreakageStart`](RASimulatorRun.md#generated.RASimulatorRun.GetWearEnergySpectraBreakageStart) - Use `GetWearStart` or `GetBreakageStart` instead. + * [`SetWearEnergySpectraBreakageStart`](RASimulatorRun.md#generated.RASimulatorRun.SetWearEnergySpectraBreakageStart) - Use `SetWearStart` or `SetBreakageStart` instead. + * [`GetWearEnergySpectraBreakageDelayAfterRelease`](RASimulatorRun.md#generated.RASimulatorRun.GetWearEnergySpectraBreakageDelayAfterRelease) - Use `GetBreakageDelayAfterRelease` instead. + * [`SetWearEnergySpectraBreakageDelayAfterRelease`](RASimulatorRun.md#generated.RASimulatorRun.SetWearEnergySpectraBreakageDelayAfterRelease) - Use `SetBreakageDelayAfterRelease` instead. + * [`GetSimulationOutputFrequency`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationOutputFrequency) - Use `GetTimeInterval` instead. + * [`SetSimulationOutputFrequency`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationOutputFrequency) - Use `SetTimeInterval` instead. + * [`GetSolverCurvesOutputFrequency`](RASimulatorRun.md#generated.RASimulatorRun.GetSolverCurvesOutputFrequency) - Use `GetSolverCurvesFrequency` instead. + * [`SetSolverCurvesOutputFrequency`](RASimulatorRun.md#generated.RASimulatorRun.SetSolverCurvesOutputFrequency) - Use `SetSolverCurvesFrequency` instead. +* [`RASPHSettings`](RASPHSettings.md) + * [`GetBackgroundPressure`](RASPHSettings.md#generated.RASPHSettings.GetBackgroundPressure) - The Background Pressure parameter was removed from Rocky since 24R1. + * [`SetBackgroundPressure`](RASPHSettings.md#generated.RASPHSettings.SetBackgroundPressure) - The Background Pressure parameter was removed from Rocky since 24R1. +* [`RAStudy`](RAStudy.md) + * [`CreateParticleInput`](RAStudy.md#generated.RAStudy.CreateParticleInput) - Use `CreateParticleInlet` instead. + * [`CreateContinuousInjection`](RAStudy.md#generated.RAStudy.CreateContinuousInjection) - Use `CreateParticleInlet` instead. + * [`CreateVolumeFill`](RAStudy.md#generated.RAStudy.CreateVolumeFill) - Use `CreateVolumetricInlet` instead. + * [`CreateInlet`](RAStudy.md#generated.RAStudy.CreateInlet) - Use `'CreateRectangularSurface` or `CreateCircularSurface'` instead. + * [`ImportCustomGeometries`](RAStudy.md#generated.RAStudy.ImportCustomGeometries) - Use `ImportWall` instead. + * [`ImportGeometries`](RAStudy.md#generated.RAStudy.ImportGeometries) - Use `ImportWall` instead. + * [`GetCustomGeometriesFromFilename`](RAStudy.md#generated.RAStudy.GetCustomGeometriesFromFilename) - Use `GetWallFromFilename` instead. + * [`GetGeometriesFromFilename`](RAStudy.md#generated.RAStudy.GetGeometriesFromFilename) - Use `GetWallFromFilename` instead. + * [`ReplaceCustomGeometryTriangles`](RAStudy.md#generated.RAStudy.ReplaceCustomGeometryTriangles) - Use `ReplaceWallTriangles` instead. + * [`ReplaceGeometryTriangles`](RAStudy.md#generated.RAStudy.ReplaceGeometryTriangles) - Use `ReplaceWallTriangles` instead. + * [`RemoveCustomGeometries`](RAStudy.md#generated.RAStudy.RemoveCustomGeometries) - Use `RemoveWall` instead. + * [`RemoveGeometries`](RAStudy.md#generated.RAStudy.RemoveGeometries) - Use `RemoveWall` instead. + * [`GetParticleInputCollection`](RAStudy.md#generated.RAStudy.GetParticleInputCollection) - Use `GetInletsOutletsCollection` instead. + * [`GetParticlesCalculations`](RAStudy.md#generated.RAStudy.GetParticlesCalculations) - Use `GetCalculations` instead. + * [`CreateMaterialAndRelatedInteractions`](RAStudy.md#generated.RAStudy.CreateMaterialAndRelatedInteractions) - Use `CreateSolidMaterialAndRelatedInteractions` instead. + * [`RemoveMaterialAndRelatedInteractions`](RAStudy.md#generated.RAStudy.RemoveMaterialAndRelatedInteractions) - Use `RemoveSolidMaterialAndRelatedInteractions` instead. +* [`RAVolumetricInlet`](RAVolumetricInlet.md) + * [`GetCustomGeometries`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetCustomGeometries) - Use `GetGeometries` instead. + * [`SetCustomGeometries`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetCustomGeometries) - Use `SetGeometries` instead. + * [`GetUseCustomGeometriesToCompute`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseCustomGeometriesToCompute) - Use `GetUseGeometriesToCompute` instead. + * [`SetUseCustomGeometriesToCompute`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseCustomGeometriesToCompute) - Use `SetUseGeometriesToCompute` instead. +* [`RAWall`](RAWall.md) + * [`GetUseWear`](RAWall.md#generated.RAWall.GetUseWear) - Use `GetWearModel` instead. + * [`SetUseWear`](RAWall.md#generated.RAWall.SetUseWear) - Use `SetWearModel` instead. + * [`GetHorizontalOffset`](RAWall.md#generated.RAWall.GetHorizontalOffset) - Use `GetTranslation` instead. + * [`SetHorizontalOffset`](RAWall.md#generated.RAWall.SetHorizontalOffset) - Use `SetTranslation` instead. + * [`GetVerticalOffset`](RAWall.md#generated.RAWall.GetVerticalOffset) - Use `GetTranslation` instead. + * [`SetVerticalOffset`](RAWall.md#generated.RAWall.SetVerticalOffset) - Use `SetTranslation` instead. + * [`GetOutOfPlaneOffset`](RAWall.md#generated.RAWall.GetOutOfPlaneOffset) - Use `GetTranslation` instead. + * [`SetOutOfPlaneOffset`](RAWall.md#generated.RAWall.SetOutOfPlaneOffset) - Use `SetTranslation` instead. +* [`RAMotionFrame`](RAMotionFrame.md) + * [`GetRotationAngle`](RAMotionFrame.md#generated.RAMotionFrame.GetRotationAngle) - Use `GetOrientationFromAngleAndVector` instead. + * [`SetRotationAngle`](RAMotionFrame.md#generated.RAMotionFrame.SetRotationAngle) - Use `SetOrientationFromAngleAndVector` instead. + * [`GetRelativeRotationVector`](RAMotionFrame.md#generated.RAMotionFrame.GetRelativeRotationVector) - Use `GetOrientationFromAngleAndVector` instead. + * [`SetRelativeRotationVector`](RAMotionFrame.md#generated.RAMotionFrame.SetRelativeRotationVector) - Use `SetOrientationFromAngleAndVector` instead. +* [`RAMaterialCollection`](RAMaterialCollection.md) + * [`GetDefaultMaterials`](RAMaterialCollection.md#generated.RAMaterialCollection.GetDefaultMaterials) - Use `GetDefaultSolidMaterials` instead. + * [`GetMaterial`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterial) - Use `GetSolidMaterial` instead. diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/getting-started.md b/2026R1/rocky-prepost-scripting-manual-26-r1/getting-started.md index 21f6bb3011..65a3eed7c5 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/getting-started.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/getting-started.md @@ -44,9 +44,9 @@ inter_1.SetAdhesiveDistance(10, 'cm') Create and configure custom geometries and surfaces: ```python -custom = study.ImportCustomGeometries('my_geometry.stl')[0] +custom = study.ImportWall('my_geometry.stl')[0] custom.SetBoundaryMass(100, 'kg') -custom.SetVerticalOffset(-10, 'cm') +custom.SetTranslation([0.0, -10, 0.0], 'cm') custom.SetMaterial('My Material') surface = study.CreateCircularSurface() @@ -66,7 +66,7 @@ particle.SetNumberOfCorners(14) particle.SetName('My Particle') particle.SetBreakageModel('ab_t10') -inlets = study.GetParticleInputCollection() +inlets = study.GetInletsOutletsCollection() inlet_1 = inlets.AddParticleInlet() inlet_1.SetName('My Particle Inlet') inlet_1.SetEntryPoint('My Surface') @@ -85,7 +85,7 @@ domain_settings = study.GetDomainSettings() domain_settings.SetUseBoundaryLimits(False) domain_settings.SetCoordinateLimitsMinValues([-2, -2, -2], 'm') domain_settings.SetCoordinateLimitsMaxValues([2, 2, 2], 'm') -domain_settings.SetBoundariesDirections('XYZ') +domain_settings.SetCartesianPeriodicDirections('XYZ') domain_settings.SetPeriodicAtGeometryLimits(True) ``` diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/index.md b/2026R1/rocky-prepost-scripting-manual-26-r1/index.md index 389d955c33..8bbc2b05be 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/index.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/index.md @@ -10,6 +10,45 @@ * [Post-Processing Results](getting-started.md#post-processing-results) * [Using VScode to Create/Edit Scripts](setup-ide.md) * [Class Reference](prepost-scripting-reference.md) + * [RA3DWindow](RA3DWindow.md) + * [`RA3DWindow`](RA3DWindow.md#generated.RA3DWindow) + * [`RA3DWindow.ApplyGridFunctionToAll()`](RA3DWindow.md#generated.RA3DWindow.ApplyGridFunctionToAll) + * [`RA3DWindow.CloseWindow()`](RA3DWindow.md#generated.RA3DWindow.CloseWindow) + * [`RA3DWindow.CreateAnimationKeyFrame()`](RA3DWindow.md#generated.RA3DWindow.CreateAnimationKeyFrame) + * [`RA3DWindow.ExportAnimation()`](RA3DWindow.md#generated.RA3DWindow.ExportAnimation) + * [`RA3DWindow.GetActiveSimulation()`](RA3DWindow.md#generated.RA3DWindow.GetActiveSimulation) + * [`RA3DWindow.GetAnimationKeyFramesCount()`](RA3DWindow.md#generated.RA3DWindow.GetAnimationKeyFramesCount) + * [`RA3DWindow.GetCamera()`](RA3DWindow.md#generated.RA3DWindow.GetCamera) + * [`RA3DWindow.GetSize()`](RA3DWindow.md#generated.RA3DWindow.GetSize) + * [`RA3DWindow.Hide()`](RA3DWindow.md#generated.RA3DWindow.Hide) + * [`RA3DWindow.HideEdges()`](RA3DWindow.md#generated.RA3DWindow.HideEdges) + * [`RA3DWindow.HideNodes()`](RA3DWindow.md#generated.RA3DWindow.HideNodes) + * [`RA3DWindow.RemoveAllAnimationKeyFrames()`](RA3DWindow.md#generated.RA3DWindow.RemoveAllAnimationKeyFrames) + * [`RA3DWindow.Resize()`](RA3DWindow.md#generated.RA3DWindow.Resize) + * [`RA3DWindow.SetActiveSimulation()`](RA3DWindow.md#generated.RA3DWindow.SetActiveSimulation) + * [`RA3DWindow.SetAnimationCameraInterpolation()`](RA3DWindow.md#generated.RA3DWindow.SetAnimationCameraInterpolation) + * [`RA3DWindow.SetAnimationFPS()`](RA3DWindow.md#generated.RA3DWindow.SetAnimationFPS) + * [`RA3DWindow.SetBackgroundColor()`](RA3DWindow.md#generated.RA3DWindow.SetBackgroundColor) + * [`RA3DWindow.SetCameraPreset()`](RA3DWindow.md#generated.RA3DWindow.SetCameraPreset) + * [`RA3DWindow.SetEdgesVisible()`](RA3DWindow.md#generated.RA3DWindow.SetEdgesVisible) + * [`RA3DWindow.SetForegroundColor()`](RA3DWindow.md#generated.RA3DWindow.SetForegroundColor) + * [`RA3DWindow.SetNodesVisible()`](RA3DWindow.md#generated.RA3DWindow.SetNodesVisible) + * [`RA3DWindow.SetSelectedWindow()`](RA3DWindow.md#generated.RA3DWindow.SetSelectedWindow) + * [`RA3DWindow.SetTransparency()`](RA3DWindow.md#generated.RA3DWindow.SetTransparency) + * [`RA3DWindow.SetVisible()`](RA3DWindow.md#generated.RA3DWindow.SetVisible) + * [`RA3DWindow.Show()`](RA3DWindow.md#generated.RA3DWindow.Show) + * [`RA3DWindow.ShowEdges()`](RA3DWindow.md#generated.RA3DWindow.ShowEdges) + * [`RA3DWindow.ShowGeometryGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowGeometryGridFunction) + * [`RA3DWindow.ShowGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowGridFunction) + * [`RA3DWindow.ShowMaximized()`](RA3DWindow.md#generated.RA3DWindow.ShowMaximized) + * [`RA3DWindow.ShowMinimized()`](RA3DWindow.md#generated.RA3DWindow.ShowMinimized) + * [`RA3DWindow.ShowModel()`](RA3DWindow.md#generated.RA3DWindow.ShowModel) + * [`RA3DWindow.ShowNodes()`](RA3DWindow.md#generated.RA3DWindow.ShowNodes) + * [`RA3DWindow.ShowNormal()`](RA3DWindow.md#generated.RA3DWindow.ShowNormal) + * [`RA3DWindow.ShowParticleGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowParticleGridFunction) + * [`RA3DWindow.ShowSphGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowSphGridFunction) + * [`RA3DWindow.Snapshot()`](RA3DWindow.md#generated.RA3DWindow.Snapshot) + * [`RA3DWindow.app`](RA3DWindow.md#generated.RA3DWindow.app) * [RAAirFlow](RAAirFlow.md) * [`RAAirFlow`](RAAirFlow.md#generated.RAAirFlow) * [`RAAirFlow.AddCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCurve) @@ -41,7 +80,10 @@ * [`RAAirFlow.GetCurveNames()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNames) * [`RAAirFlow.GetCurveNamesAssociation()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNamesAssociation) * [`RAAirFlow.GetElementCurve()`](RAAirFlow.md#generated.RAAirFlow.GetElementCurve) + * [`RAAirFlow.GetFacePositions()`](RAAirFlow.md#generated.RAAirFlow.GetFacePositions) + * [`RAAirFlow.GetFaceVertices()`](RAAirFlow.md#generated.RAAirFlow.GetFaceVertices) * [`RAAirFlow.GetGeometryQuantity()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryQuantity) + * [`RAAirFlow.GetGeometryTransform()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryTransform) * [`RAAirFlow.GetGeometryUnit()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryUnit) * [`RAAirFlow.GetGridFunction()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunction) * [`RAAirFlow.GetGridFunctionNames()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunctionNames) @@ -66,6 +108,7 @@ * [`RAAirFlow.GetTopologyShape()`](RAAirFlow.md#generated.RAAirFlow.GetTopologyShape) * [`RAAirFlow.GetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.GetUseAirflow) * [`RAAirFlow.GetValidBoundaryConditionTypeValues()`](RAAirFlow.md#generated.RAAirFlow.GetValidBoundaryConditionTypeValues) + * [`RAAirFlow.GetVertices()`](RAAirFlow.md#generated.RAAirFlow.GetVertices) * [`RAAirFlow.HasGridFunction()`](RAAirFlow.md#generated.RAAirFlow.HasGridFunction) * [`RAAirFlow.IsCellActive()`](RAAirFlow.md#generated.RAAirFlow.IsCellActive) * [`RAAirFlow.IterCellVertices()`](RAAirFlow.md#generated.RAAirFlow.IterCellVertices) @@ -94,20 +137,13 @@ * [`RAAirFlow.SetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.SetUseAirflow) * [RACFDCoupling](RACFDCoupling.md) * [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling) - * [`RACFDCoupling.GetAirFlow()`](RACFDCoupling.md#generated.RACFDCoupling.GetAirFlow) * [`RACFDCoupling.GetCouplingMode()`](RACFDCoupling.md#generated.RACFDCoupling.GetCouplingMode) * [`RACFDCoupling.GetCouplingProcess()`](RACFDCoupling.md#generated.RACFDCoupling.GetCouplingProcess) * [`RACFDCoupling.GetOneWayLBM()`](RACFDCoupling.md#generated.RACFDCoupling.GetOneWayLBM) - * [`RACFDCoupling.SetupAirFlow()`](RACFDCoupling.md#generated.RACFDCoupling.SetupAirFlow) - * [`RACFDCoupling.SetupCFDConstantOneWayCouplingProcess()`](RACFDCoupling.md#generated.RACFDCoupling.SetupCFDConstantOneWayCouplingProcess) - * [`RACFDCoupling.SetupConstantOneWay()`](RACFDCoupling.md#generated.RACFDCoupling.SetupConstantOneWay) - * [`RACFDCoupling.SetupFluentOneWaySteadyState()`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentOneWaySteadyState) - * [`RACFDCoupling.SetupFluentTwoWay()`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentTwoWay) * [`RACFDCoupling.SetupFluentTwoWaySemiResolved()`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentTwoWaySemiResolved) * [`RACFDCoupling.SetupNoCoupling()`](RACFDCoupling.md#generated.RACFDCoupling.SetupNoCoupling) * [`RACFDCoupling.SetupOneWayConstant()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayConstant) * [`RACFDCoupling.SetupOneWayFluent()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayFluent) - * [`RACFDCoupling.SetupOneWayFluentSteadyState()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayFluentSteadyState) * [`RACFDCoupling.SetupOneWayLBM()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayLBM) * [`RACFDCoupling.SetupTwoWayFluent()`](RACFDCoupling.md#generated.RACFDCoupling.SetupTwoWayFluent) * [RACFDParametersList](RACFDParametersList.md) @@ -150,7 +186,6 @@ * [`RACalculations.CreateDivisionsTagging()`](RACalculations.md#generated.RACalculations.CreateDivisionsTagging) * [`RACalculations.CreateSelectionFlipCount()`](RACalculations.md#generated.RACalculations.CreateSelectionFlipCount) * [`RACalculations.CreateSelectionResidenceTime()`](RACalculations.md#generated.RACalculations.CreateSelectionResidenceTime) - * [`RACalculations.CreateSelectionTagging()`](RACalculations.md#generated.RACalculations.CreateSelectionTagging) * [`RACalculations.CreateTagging()`](RACalculations.md#generated.RACalculations.CreateTagging) * [`RACalculations.GetDivisionsTagging()`](RACalculations.md#generated.RACalculations.GetDivisionsTagging) * [`RACalculations.GetDivisionsTaggingNames()`](RACalculations.md#generated.RACalculations.GetDivisionsTaggingNames) @@ -184,13 +219,17 @@ * [`RACircularSurface.GetCurveNames()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNames) * [`RACircularSurface.GetCurveNamesAssociation()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNamesAssociation) * [`RACircularSurface.GetElementCurve()`](RACircularSurface.md#generated.RACircularSurface.GetElementCurve) + * [`RACircularSurface.GetFacePositions()`](RACircularSurface.md#generated.RACircularSurface.GetFacePositions) + * [`RACircularSurface.GetFaceVertices()`](RACircularSurface.md#generated.RACircularSurface.GetFaceVertices) * [`RACircularSurface.GetGeometryQuantity()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryQuantity) + * [`RACircularSurface.GetGeometryTransform()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryTransform) * [`RACircularSurface.GetGeometryUnit()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryUnit) * [`RACircularSurface.GetGridFunction()`](RACircularSurface.md#generated.RACircularSurface.GetGridFunction) * [`RACircularSurface.GetGridFunctionNames()`](RACircularSurface.md#generated.RACircularSurface.GetGridFunctionNames) * [`RACircularSurface.GetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.GetMaxRadius) * [`RACircularSurface.GetMeshColoring()`](RACircularSurface.md#generated.RACircularSurface.GetMeshColoring) * [`RACircularSurface.GetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.GetMinRadius) + * [`RACircularSurface.GetMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.GetMotionFrame) * [`RACircularSurface.GetNumberOfCells()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfCells) * [`RACircularSurface.GetNumberOfNodes()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfNodes) * [`RACircularSurface.GetNumpyCurve()`](RACircularSurface.md#generated.RACircularSurface.GetNumpyCurve) @@ -203,6 +242,7 @@ * [`RACircularSurface.GetTimeStatistics()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStatistics) * [`RACircularSurface.GetTimeStep()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStep) * [`RACircularSurface.GetTopologyShape()`](RACircularSurface.md#generated.RACircularSurface.GetTopologyShape) + * [`RACircularSurface.GetVertices()`](RACircularSurface.md#generated.RACircularSurface.GetVertices) * [`RACircularSurface.HasGridFunction()`](RACircularSurface.md#generated.RACircularSurface.HasGridFunction) * [`RACircularSurface.HasMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.HasMotionFrame) * [`RACircularSurface.IsCellActive()`](RACircularSurface.md#generated.RACircularSurface.IsCellActive) @@ -217,6 +257,7 @@ * [`RACircularSurface.SetCurrentTimeStep()`](RACircularSurface.md#generated.RACircularSurface.SetCurrentTimeStep) * [`RACircularSurface.SetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMaxRadius) * [`RACircularSurface.SetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMinRadius) + * [`RACircularSurface.SetMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.SetMotionFrame) * [`RACircularSurface.SetOrientation()`](RACircularSurface.md#generated.RACircularSurface.SetOrientation) * [`RACircularSurface.SetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngleAndVector) * [`RACircularSurface.SetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngles) @@ -274,7 +315,10 @@ * [`RAConstantOneWayCoupling.GetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDensity) * [`RAConstantOneWayCoupling.GetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDragLaw) * [`RAConstantOneWayCoupling.GetElementCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetElementCurve) + * [`RAConstantOneWayCoupling.GetFacePositions()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetFacePositions) + * [`RAConstantOneWayCoupling.GetFaceVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetFaceVertices) * [`RAConstantOneWayCoupling.GetGeometryQuantity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryQuantity) + * [`RAConstantOneWayCoupling.GetGeometryTransform()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryTransform) * [`RAConstantOneWayCoupling.GetGeometryUnit()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryUnit) * [`RAConstantOneWayCoupling.GetGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunction) * [`RAConstantOneWayCoupling.GetGridFunctionNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunctionNames) @@ -303,6 +347,7 @@ * [`RAConstantOneWayCoupling.GetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion) * [`RAConstantOneWayCoupling.GetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants) * [`RAConstantOneWayCoupling.GetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVelocity) + * [`RAConstantOneWayCoupling.GetVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVertices) * [`RAConstantOneWayCoupling.GetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVirtualMassLaw) * [`RAConstantOneWayCoupling.GetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetViscosity) * [`RAConstantOneWayCoupling.HasGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.HasGridFunction) @@ -370,7 +415,10 @@ * [`RAContactData.GetCurveNames()`](RAContactData.md#generated.RAContactData.GetCurveNames) * [`RAContactData.GetCurveNamesAssociation()`](RAContactData.md#generated.RAContactData.GetCurveNamesAssociation) * [`RAContactData.GetElementCurve()`](RAContactData.md#generated.RAContactData.GetElementCurve) + * [`RAContactData.GetFacePositions()`](RAContactData.md#generated.RAContactData.GetFacePositions) + * [`RAContactData.GetFaceVertices()`](RAContactData.md#generated.RAContactData.GetFaceVertices) * [`RAContactData.GetGeometryQuantity()`](RAContactData.md#generated.RAContactData.GetGeometryQuantity) + * [`RAContactData.GetGeometryTransform()`](RAContactData.md#generated.RAContactData.GetGeometryTransform) * [`RAContactData.GetGeometryUnit()`](RAContactData.md#generated.RAContactData.GetGeometryUnit) * [`RAContactData.GetGridFunction()`](RAContactData.md#generated.RAContactData.GetGridFunction) * [`RAContactData.GetGridFunctionNames()`](RAContactData.md#generated.RAContactData.GetGridFunctionNames) @@ -384,6 +432,7 @@ * [`RAContactData.GetTimeStatistics()`](RAContactData.md#generated.RAContactData.GetTimeStatistics) * [`RAContactData.GetTimeStep()`](RAContactData.md#generated.RAContactData.GetTimeStep) * [`RAContactData.GetTopologyShape()`](RAContactData.md#generated.RAContactData.GetTopologyShape) + * [`RAContactData.GetVertices()`](RAContactData.md#generated.RAContactData.GetVertices) * [`RAContactData.HasGridFunction()`](RAContactData.md#generated.RAContactData.HasGridFunction) * [`RAContactData.IsCellActive()`](RAContactData.md#generated.RAContactData.IsCellActive) * [`RAContactData.IsCollectContactsDataEnabled()`](RAContactData.md#generated.RAContactData.IsCollectContactsDataEnabled) @@ -425,7 +474,10 @@ * [`RAContactToParticleProcess.GetCurveNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNames) * [`RAContactToParticleProcess.GetCurveNamesAssociation()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNamesAssociation) * [`RAContactToParticleProcess.GetElementCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetElementCurve) + * [`RAContactToParticleProcess.GetFacePositions()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetFacePositions) + * [`RAContactToParticleProcess.GetFaceVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetFaceVertices) * [`RAContactToParticleProcess.GetGeometryQuantity()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryQuantity) + * [`RAContactToParticleProcess.GetGeometryTransform()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryTransform) * [`RAContactToParticleProcess.GetGeometryUnit()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryUnit) * [`RAContactToParticleProcess.GetGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunction) * [`RAContactToParticleProcess.GetGridFunctionNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunctionNames) @@ -439,6 +491,7 @@ * [`RAContactToParticleProcess.GetTimeStatistics()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStatistics) * [`RAContactToParticleProcess.GetTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStep) * [`RAContactToParticleProcess.GetTopologyShape()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTopologyShape) + * [`RAContactToParticleProcess.GetVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetVertices) * [`RAContactToParticleProcess.HasGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.HasGridFunction) * [`RAContactToParticleProcess.IsCellActive()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IsCellActive) * [`RAContactToParticleProcess.IterCellVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCellVertices) @@ -501,7 +554,10 @@ * [`RACoupledWall.GetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.GetDisableTime) * [`RACoupledWall.GetElementCurve()`](RACoupledWall.md#generated.RACoupledWall.GetElementCurve) * [`RACoupledWall.GetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.GetEnableTime) + * [`RACoupledWall.GetFacePositions()`](RACoupledWall.md#generated.RACoupledWall.GetFacePositions) + * [`RACoupledWall.GetFaceVertices()`](RACoupledWall.md#generated.RACoupledWall.GetFaceVertices) * [`RACoupledWall.GetGeometryQuantity()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryQuantity) + * [`RACoupledWall.GetGeometryTransform()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryTransform) * [`RACoupledWall.GetGeometryUnit()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryUnit) * [`RACoupledWall.GetGridFunction()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunction) * [`RACoupledWall.GetGridFunctionNames()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunctionNames) @@ -509,6 +565,7 @@ * [`RACoupledWall.GetMeshColoring()`](RACoupledWall.md#generated.RACoupledWall.GetMeshColoring) * [`RACoupledWall.GetModuleProperties()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperties) * [`RACoupledWall.GetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperty) + * [`RACoupledWall.GetMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.GetMotionFrame) * [`RACoupledWall.GetNumberOfCells()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfCells) * [`RACoupledWall.GetNumberOfNodes()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfNodes) * [`RACoupledWall.GetNumpyCurve()`](RACoupledWall.md#generated.RACoupledWall.GetNumpyCurve) @@ -518,6 +575,7 @@ * [`RACoupledWall.GetTimeStep()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStep) * [`RACoupledWall.GetTopologyShape()`](RACoupledWall.md#generated.RACoupledWall.GetTopologyShape) * [`RACoupledWall.GetValidOptionsForModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetValidOptionsForModuleProperty) + * [`RACoupledWall.GetVertices()`](RACoupledWall.md#generated.RACoupledWall.GetVertices) * [`RACoupledWall.HasGridFunction()`](RACoupledWall.md#generated.RACoupledWall.HasGridFunction) * [`RACoupledWall.HasMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.HasMotionFrame) * [`RACoupledWall.IsCellActive()`](RACoupledWall.md#generated.RACoupledWall.IsCellActive) @@ -533,6 +591,7 @@ * [`RACoupledWall.SetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.SetEnableTime) * [`RACoupledWall.SetMaterial()`](RACoupledWall.md#generated.RACoupledWall.SetMaterial) * [`RACoupledWall.SetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.SetModuleProperty) + * [`RACoupledWall.SetMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.SetMotionFrame) * [RACubeGroup](RACubeGroup.md) * [`RACubeGroup`](RACubeGroup.md#generated.RACubeGroup) * [`RACubeGroup.AddCurve()`](RACubeGroup.md#generated.RACubeGroup.AddCurve) @@ -583,14 +642,14 @@ * [`RACubeProcess.GetCellVolumeAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellVolumeAsArray) * [`RACubeProcess.GetCenter()`](RACubeProcess.md#generated.RACubeProcess.GetCenter) * [`RACubeProcess.GetCenterAfterMovement()`](RACubeProcess.md#generated.RACubeProcess.GetCenterAfterMovement) - * [`RACubeProcess.GetCubeCenter()`](RACubeProcess.md#generated.RACubeProcess.GetCubeCenter) - * [`RACubeProcess.GetCubeMagnitude()`](RACubeProcess.md#generated.RACubeProcess.GetCubeMagnitude) - * [`RACubeProcess.GetCubeRotation()`](RACubeProcess.md#generated.RACubeProcess.GetCubeRotation) * [`RACubeProcess.GetCurve()`](RACubeProcess.md#generated.RACubeProcess.GetCurve) * [`RACubeProcess.GetCurveNames()`](RACubeProcess.md#generated.RACubeProcess.GetCurveNames) * [`RACubeProcess.GetCurveNamesAssociation()`](RACubeProcess.md#generated.RACubeProcess.GetCurveNamesAssociation) * [`RACubeProcess.GetElementCurve()`](RACubeProcess.md#generated.RACubeProcess.GetElementCurve) + * [`RACubeProcess.GetFacePositions()`](RACubeProcess.md#generated.RACubeProcess.GetFacePositions) + * [`RACubeProcess.GetFaceVertices()`](RACubeProcess.md#generated.RACubeProcess.GetFaceVertices) * [`RACubeProcess.GetGeometryQuantity()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryQuantity) + * [`RACubeProcess.GetGeometryTransform()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryTransform) * [`RACubeProcess.GetGeometryUnit()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryUnit) * [`RACubeProcess.GetGridFunction()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunction) * [`RACubeProcess.GetGridFunctionNames()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunctionNames) @@ -611,6 +670,7 @@ * [`RACubeProcess.GetTimeStatistics()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStatistics) * [`RACubeProcess.GetTimeStep()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStep) * [`RACubeProcess.GetTopologyShape()`](RACubeProcess.md#generated.RACubeProcess.GetTopologyShape) + * [`RACubeProcess.GetVertices()`](RACubeProcess.md#generated.RACubeProcess.GetVertices) * [`RACubeProcess.HasGridFunction()`](RACubeProcess.md#generated.RACubeProcess.HasGridFunction) * [`RACubeProcess.IsCellActive()`](RACubeProcess.md#generated.RACubeProcess.IsCellActive) * [`RACubeProcess.IterCellVertices()`](RACubeProcess.md#generated.RACubeProcess.IterCellVertices) @@ -622,9 +682,6 @@ * [`RACubeProcess.RemoveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.RemoveOutputVariable) * [`RACubeProcess.RemoveProcess()`](RACubeProcess.md#generated.RACubeProcess.RemoveProcess) * [`RACubeProcess.SetCenter()`](RACubeProcess.md#generated.RACubeProcess.SetCenter) - * [`RACubeProcess.SetCubeCenter()`](RACubeProcess.md#generated.RACubeProcess.SetCubeCenter) - * [`RACubeProcess.SetCubeMagnitude()`](RACubeProcess.md#generated.RACubeProcess.SetCubeMagnitude) - * [`RACubeProcess.SetCubeRotation()`](RACubeProcess.md#generated.RACubeProcess.SetCubeRotation) * [`RACubeProcess.SetCurrentTimeStep()`](RACubeProcess.md#generated.RACubeProcess.SetCurrentTimeStep) * [`RACubeProcess.SetMotionFrame()`](RACubeProcess.md#generated.RACubeProcess.SetMotionFrame) * [`RACubeProcess.SetOrientation()`](RACubeProcess.md#generated.RACubeProcess.SetOrientation) @@ -633,6 +690,28 @@ * [`RACubeProcess.SetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromBasisVector) * [`RACubeProcess.SetRotation()`](RACubeProcess.md#generated.RACubeProcess.SetRotation) * [`RACubeProcess.SetSize()`](RACubeProcess.md#generated.RACubeProcess.SetSize) + * [RACurve](RACurve.md) + * [`RACurve`](RACurve.md#generated.RACurve) + * [`RACurve.CrossFromAbove()`](RACurve.md#generated.RACurve.CrossFromAbove) + * [`RACurve.CrossFromBellow()`](RACurve.md#generated.RACurve.CrossFromBellow) + * [`RACurve.GetStatistics()`](RACurve.md#generated.RACurve.GetStatistics) + * [`RACurve.GetTimeSet()`](RACurve.md#generated.RACurve.GetTimeSet) + * [`RACurve.GetUnit()`](RACurve.md#generated.RACurve.GetUnit) + * [`RACurve.GetX()`](RACurve.md#generated.RACurve.GetX) + * [`RACurve.GetXUnit()`](RACurve.md#generated.RACurve.GetXUnit) + * [`RACurve.GetY()`](RACurve.md#generated.RACurve.GetY) + * [`RACurve.Interpolate()`](RACurve.md#generated.RACurve.Interpolate) + * [`RACurve.Reset()`](RACurve.md#generated.RACurve.Reset) + * [`RACurve.SetFrequency()`](RACurve.md#generated.RACurve.SetFrequency) + * [`RACurve.SetUnit()`](RACurve.md#generated.RACurve.SetUnit) + * [`RACurve.SetXUnit()`](RACurve.md#generated.RACurve.SetXUnit) + * [`RACurve.curve_name`](RACurve.md#generated.RACurve.curve_name) + * [`RACurve.element_name`](RACurve.md#generated.RACurve.element_name) + * [`RACurve.simulation_name`](RACurve.md#generated.RACurve.simulation_name) + * [`RACurve.unit`](RACurve.md#generated.RACurve.unit) + * [`RACurve.x`](RACurve.md#generated.RACurve.x) + * [`RACurve.x_unit`](RACurve.md#generated.RACurve.x_unit) + * [`RACurve.y`](RACurve.md#generated.RACurve.y) * [RACustomInput](RACustomInput.md) * [`RACustomInput`](RACustomInput.md#generated.RACustomInput) * [`RACustomInput.GetAvailableMotionFrames()`](RACustomInput.md#generated.RACustomInput.GetAvailableMotionFrames) @@ -709,8 +788,11 @@ * [`RACylinderProcess.GetCurveNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNames) * [`RACylinderProcess.GetCurveNamesAssociation()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNamesAssociation) * [`RACylinderProcess.GetElementCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetElementCurve) + * [`RACylinderProcess.GetFacePositions()`](RACylinderProcess.md#generated.RACylinderProcess.GetFacePositions) + * [`RACylinderProcess.GetFaceVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetFaceVertices) * [`RACylinderProcess.GetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetFinalAngle) * [`RACylinderProcess.GetGeometryQuantity()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryQuantity) + * [`RACylinderProcess.GetGeometryTransform()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryTransform) * [`RACylinderProcess.GetGeometryUnit()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryUnit) * [`RACylinderProcess.GetGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunction) * [`RACylinderProcess.GetGridFunctionNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunctionNames) @@ -733,6 +815,7 @@ * [`RACylinderProcess.GetTimeStatistics()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStatistics) * [`RACylinderProcess.GetTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStep) * [`RACylinderProcess.GetTopologyShape()`](RACylinderProcess.md#generated.RACylinderProcess.GetTopologyShape) + * [`RACylinderProcess.GetVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetVertices) * [`RACylinderProcess.HasGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.HasGridFunction) * [`RACylinderProcess.IsCellActive()`](RACylinderProcess.md#generated.RACylinderProcess.IsCellActive) * [`RACylinderProcess.IterCellVertices()`](RACylinderProcess.md#generated.RACylinderProcess.IterCellVertices) @@ -777,7 +860,6 @@ * [`RADomainSettings.DisableUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.DisableUseBoundaryLimits) * [`RADomainSettings.EnablePeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.EnablePeriodicAtGeometryLimits) * [`RADomainSettings.EnableUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.EnableUseBoundaryLimits) - * [`RADomainSettings.GetBoundariesDirections()`](RADomainSettings.md#generated.RADomainSettings.GetBoundariesDirections) * [`RADomainSettings.GetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.GetCartesianPeriodicDirections) * [`RADomainSettings.GetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.GetCoordinateLimitsMaxValues) * [`RADomainSettings.GetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.GetCoordinateLimitsMinValues) @@ -789,13 +871,12 @@ * [`RADomainSettings.GetPeriodicLimitsMaxCoordinates()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicLimitsMaxCoordinates) * [`RADomainSettings.GetPeriodicLimitsMinCoordinates()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicLimitsMinCoordinates) * [`RADomainSettings.GetUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.GetUseBoundaryLimits) - * [`RADomainSettings.GetValidBoundariesDirectionsValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidBoundariesDirectionsValues) * [`RADomainSettings.GetValidCartesianPeriodicDirectionsValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidCartesianPeriodicDirectionsValues) * [`RADomainSettings.GetValidCylindricalPeriodicDirectionsValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidCylindricalPeriodicDirectionsValues) * [`RADomainSettings.GetValidDomainTypeValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidDomainTypeValues) * [`RADomainSettings.IsPeriodicAtGeometryLimitsEnabled()`](RADomainSettings.md#generated.RADomainSettings.IsPeriodicAtGeometryLimitsEnabled) * [`RADomainSettings.IsUseBoundaryLimitsEnabled()`](RADomainSettings.md#generated.RADomainSettings.IsUseBoundaryLimitsEnabled) - * [`RADomainSettings.SetBoundariesDirections()`](RADomainSettings.md#generated.RADomainSettings.SetBoundariesDirections) + * [`RADomainSettings.ResetDomainToGeometriesLimits()`](RADomainSettings.md#generated.RADomainSettings.ResetDomainToGeometriesLimits) * [`RADomainSettings.SetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCartesianPeriodicDirections) * [`RADomainSettings.SetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMaxValues) * [`RADomainSettings.SetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMinValues) @@ -837,7 +918,10 @@ * [`RAEulerianStatistics.GetCurveNamesAssociation()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNamesAssociation) * [`RAEulerianStatistics.GetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetDivisions) * [`RAEulerianStatistics.GetElementCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetElementCurve) + * [`RAEulerianStatistics.GetFacePositions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetFacePositions) + * [`RAEulerianStatistics.GetFaceVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetFaceVertices) * [`RAEulerianStatistics.GetGeometryQuantity()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryQuantity) + * [`RAEulerianStatistics.GetGeometryTransform()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryTransform) * [`RAEulerianStatistics.GetGeometryUnit()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryUnit) * [`RAEulerianStatistics.GetGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunction) * [`RAEulerianStatistics.GetGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunctionNames) @@ -852,6 +936,7 @@ * [`RAEulerianStatistics.GetTimeStatistics()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStatistics) * [`RAEulerianStatistics.GetTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStep) * [`RAEulerianStatistics.GetTopologyShape()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTopologyShape) + * [`RAEulerianStatistics.GetVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetVertices) * [`RAEulerianStatistics.HasGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.HasGridFunction) * [`RAEulerianStatistics.IsCellActive()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IsCellActive) * [`RAEulerianStatistics.IterCellVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCellVertices) @@ -898,6 +983,7 @@ * [`RAFeedConveyor.GetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltThickness) * [`RAFeedConveyor.GetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltWidth) * [`RAFeedConveyor.GetBoundingBox()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBoundingBox) + * [`RAFeedConveyor.GetCapillaryFrictionCoefficient()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCapillaryFrictionCoefficient) * [`RAFeedConveyor.GetCellAreaAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellAreaAsArray) * [`RAFeedConveyor.GetCellCenterAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellCenterAsArray) * [`RAFeedConveyor.GetCellDzAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellDzAsArray) @@ -915,9 +1001,12 @@ * [`RAFeedConveyor.GetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxLength) * [`RAFeedConveyor.GetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxWidth) * [`RAFeedConveyor.GetElementCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetElementCurve) + * [`RAFeedConveyor.GetFacePositions()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFacePositions) + * [`RAFeedConveyor.GetFaceVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceVertices) * [`RAFeedConveyor.GetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceWidth) * [`RAFeedConveyor.GetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFrontPlateOffset) * [`RAFeedConveyor.GetGeometryQuantity()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryQuantity) + * [`RAFeedConveyor.GetGeometryTransform()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryTransform) * [`RAFeedConveyor.GetGeometryUnit()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryUnit) * [`RAFeedConveyor.GetGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunction) * [`RAFeedConveyor.GetGridFunctionNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunctionNames) @@ -953,6 +1042,7 @@ * [`RAFeedConveyor.GetValidSphBoundaryTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues) * [`RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues) * [`RAFeedConveyor.GetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVerticalOffset) + * [`RAFeedConveyor.GetVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVertices) * [`RAFeedConveyor.GetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWallThickness) * [`RAFeedConveyor.GetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWidth) * [`RAFeedConveyor.HasGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.HasGridFunction) @@ -973,6 +1063,7 @@ * [`RAFeedConveyor.SetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltSpeed) * [`RAFeedConveyor.SetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltThickness) * [`RAFeedConveyor.SetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltWidth) + * [`RAFeedConveyor.SetCapillaryFrictionCoefficient()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCapillaryFrictionCoefficient) * [`RAFeedConveyor.SetCurrentTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCurrentTimeStep) * [`RAFeedConveyor.SetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDecelerationPeriod) * [`RAFeedConveyor.SetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDiameter) @@ -1029,7 +1120,10 @@ * [`RAFilterProcess.GetCurveNamesAssociation()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNamesAssociation) * [`RAFilterProcess.GetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetCutValue) * [`RAFilterProcess.GetElementCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetElementCurve) + * [`RAFilterProcess.GetFacePositions()`](RAFilterProcess.md#generated.RAFilterProcess.GetFacePositions) + * [`RAFilterProcess.GetFaceVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetFaceVertices) * [`RAFilterProcess.GetGeometryQuantity()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryQuantity) + * [`RAFilterProcess.GetGeometryTransform()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryTransform) * [`RAFilterProcess.GetGeometryUnit()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryUnit) * [`RAFilterProcess.GetGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunction) * [`RAFilterProcess.GetGridFunctionNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunctionNames) @@ -1048,6 +1142,7 @@ * [`RAFilterProcess.GetTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStep) * [`RAFilterProcess.GetTopologyShape()`](RAFilterProcess.md#generated.RAFilterProcess.GetTopologyShape) * [`RAFilterProcess.GetType()`](RAFilterProcess.md#generated.RAFilterProcess.GetType) + * [`RAFilterProcess.GetVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetVertices) * [`RAFilterProcess.HasGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.HasGridFunction) * [`RAFilterProcess.IsCellActive()`](RAFilterProcess.md#generated.RAFilterProcess.IsCellActive) * [`RAFilterProcess.IterCellVertices()`](RAFilterProcess.md#generated.RAFilterProcess.IterCellVertices) @@ -1119,7 +1214,10 @@ * [`RAFluentOneWayCoupling.GetCurveNamesAssociation()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation) * [`RAFluentOneWayCoupling.GetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetDragLaw) * [`RAFluentOneWayCoupling.GetElementCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetElementCurve) + * [`RAFluentOneWayCoupling.GetFacePositions()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetFacePositions) + * [`RAFluentOneWayCoupling.GetFaceVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetFaceVertices) * [`RAFluentOneWayCoupling.GetGeometryQuantity()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryQuantity) + * [`RAFluentOneWayCoupling.GetGeometryTransform()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryTransform) * [`RAFluentOneWayCoupling.GetGeometryUnit()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryUnit) * [`RAFluentOneWayCoupling.GetGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunction) * [`RAFluentOneWayCoupling.GetGridFunctionNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunctionNames) @@ -1145,6 +1243,7 @@ * [`RAFluentOneWayCoupling.GetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion) * [`RAFluentOneWayCoupling.GetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants) * [`RAFluentOneWayCoupling.GetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance) + * [`RAFluentOneWayCoupling.GetVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVertices) * [`RAFluentOneWayCoupling.GetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVirtualMassLaw) * [`RAFluentOneWayCoupling.HasGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.HasGridFunction) * [`RAFluentOneWayCoupling.IsCellActive()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IsCellActive) @@ -1238,6 +1337,8 @@ * [`RAFluentTwoWayCoupling.GetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient) * [`RAFluentTwoWayCoupling.GetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDragLaw) * [`RAFluentTwoWayCoupling.GetElementCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetElementCurve) + * [`RAFluentTwoWayCoupling.GetFacePositions()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFacePositions) + * [`RAFluentTwoWayCoupling.GetFaceVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFaceVertices) * [`RAFluentTwoWayCoupling.GetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs) * [`RAFluentTwoWayCoupling.GetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode) * [`RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier) @@ -1246,6 +1347,7 @@ * [`RAFluentTwoWayCoupling.GetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentVersion) * [`RAFluentTwoWayCoupling.GetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFractionParticleSize) * [`RAFluentTwoWayCoupling.GetGeometryQuantity()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryQuantity) + * [`RAFluentTwoWayCoupling.GetGeometryTransform()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryTransform) * [`RAFluentTwoWayCoupling.GetGeometryUnit()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryUnit) * [`RAFluentTwoWayCoupling.GetGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunction) * [`RAFluentTwoWayCoupling.GetGridFunctionNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunctionNames) @@ -1255,7 +1357,6 @@ * [`RAFluentTwoWayCoupling.GetMaximumResidualTolerance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumResidualTolerance) * [`RAFluentTwoWayCoupling.GetMaximumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumTimeSteps) * [`RAFluentTwoWayCoupling.GetMaximumVolumeFraction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFraction) - * [`RAFluentTwoWayCoupling.GetMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFractionTarget) * [`RAFluentTwoWayCoupling.GetMeshColoring()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMeshColoring) * [`RAFluentTwoWayCoupling.GetMinimumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMinimumIterations) * [`RAFluentTwoWayCoupling.GetMinimumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMinimumTimeSteps) @@ -1286,6 +1387,7 @@ * [`RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues) * [`RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues) * [`RAFluentTwoWayCoupling.GetValidMappingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) + * [`RAFluentTwoWayCoupling.GetVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVertices) * [`RAFluentTwoWayCoupling.GetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw) * [`RAFluentTwoWayCoupling.GetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget) * [`RAFluentTwoWayCoupling.HasGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.HasGridFunction) @@ -1322,7 +1424,6 @@ * [`RAFluentTwoWayCoupling.SetMaximumResidualTolerance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumResidualTolerance) * [`RAFluentTwoWayCoupling.SetMaximumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumTimeSteps) * [`RAFluentTwoWayCoupling.SetMaximumVolumeFraction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFraction) - * [`RAFluentTwoWayCoupling.SetMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFractionTarget) * [`RAFluentTwoWayCoupling.SetMinimumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMinimumIterations) * [`RAFluentTwoWayCoupling.SetMinimumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMinimumTimeSteps) * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK1) @@ -1348,18 +1449,27 @@ * [`RAFluentTwoWayCoupling.UpdateFluentInfo()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.UpdateFluentInfo) * [RAFluidInlet](RAFluidInlet.md) * [`RAFluidInlet`](RAFluidInlet.md#generated.RAFluidInlet) + * [`RAFluidInlet.DisablePeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.DisablePeriodic) + * [`RAFluidInlet.EnablePeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.EnablePeriodic) * [`RAFluidInlet.GetAvailableEntryPoints()`](RAFluidInlet.md#generated.RAFluidInlet.GetAvailableEntryPoints) * [`RAFluidInlet.GetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.GetBoundaryCondition) * [`RAFluidInlet.GetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.GetEntryPoint) + * [`RAFluidInlet.GetInjectionDuration()`](RAFluidInlet.md#generated.RAFluidInlet.GetInjectionDuration) * [`RAFluidInlet.GetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.GetMassFlowRate) + * [`RAFluidInlet.GetPeriod()`](RAFluidInlet.md#generated.RAFluidInlet.GetPeriod) + * [`RAFluidInlet.GetPeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.GetPeriodic) * [`RAFluidInlet.GetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.GetStartTime) * [`RAFluidInlet.GetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.GetStopTime) * [`RAFluidInlet.GetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.GetTemperature) * [`RAFluidInlet.GetValidBoundaryConditionValues()`](RAFluidInlet.md#generated.RAFluidInlet.GetValidBoundaryConditionValues) * [`RAFluidInlet.GetVelocity()`](RAFluidInlet.md#generated.RAFluidInlet.GetVelocity) + * [`RAFluidInlet.IsPeriodicEnabled()`](RAFluidInlet.md#generated.RAFluidInlet.IsPeriodicEnabled) * [`RAFluidInlet.SetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.SetBoundaryCondition) * [`RAFluidInlet.SetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.SetEntryPoint) + * [`RAFluidInlet.SetInjectionDuration()`](RAFluidInlet.md#generated.RAFluidInlet.SetInjectionDuration) * [`RAFluidInlet.SetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.SetMassFlowRate) + * [`RAFluidInlet.SetPeriod()`](RAFluidInlet.md#generated.RAFluidInlet.SetPeriod) + * [`RAFluidInlet.SetPeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.SetPeriodic) * [`RAFluidInlet.SetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStartTime) * [`RAFluidInlet.SetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStopTime) * [`RAFluidInlet.SetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.SetTemperature) @@ -1369,14 +1479,12 @@ * [`RAFluidMaterial.GetDensity()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetDensity) * [`RAFluidMaterial.GetModuleProperties()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetModuleProperties) * [`RAFluidMaterial.GetModuleProperty()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetModuleProperty) - * [`RAFluidMaterial.GetSoundSpeed()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetSoundSpeed) * [`RAFluidMaterial.GetSpecificHeat()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetSpecificHeat) * [`RAFluidMaterial.GetThermalConductivity()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetThermalConductivity) * [`RAFluidMaterial.GetValidOptionsForModuleProperty()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetValidOptionsForModuleProperty) * [`RAFluidMaterial.GetViscosity()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetViscosity) * [`RAFluidMaterial.SetDensity()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetDensity) * [`RAFluidMaterial.SetModuleProperty()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetModuleProperty) - * [`RAFluidMaterial.SetSoundSpeed()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetSoundSpeed) * [`RAFluidMaterial.SetSpecificHeat()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetSpecificHeat) * [`RAFluidMaterial.SetThermalConductivity()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetThermalConductivity) * [`RAFluidMaterial.SetViscosity()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetViscosity) @@ -1392,15 +1500,48 @@ * [`RAFreeBodyTranslation.SetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.SetFreeMotionDirection) * [RAGeometryCollection](RAGeometryCollection.md) * [`RAGeometryCollection`](RAGeometryCollection.md#generated.RAGeometryCollection) + * [`RAGeometryCollection.Clear()`](RAGeometryCollection.md#generated.RAGeometryCollection.Clear) * [`RAGeometryCollection.GetBoundingBox()`](RAGeometryCollection.md#generated.RAGeometryCollection.GetBoundingBox) * [`RAGeometryCollection.GetGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.GetGeometry) * [`RAGeometryCollection.GetGeometryNames()`](RAGeometryCollection.md#generated.RAGeometryCollection.GetGeometryNames) * [`RAGeometryCollection.IterInletGeometries()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterInletGeometries) - * [`RAGeometryCollection.IterInputGeometries()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterInputGeometries) * [`RAGeometryCollection.IterSurfaces()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterSurfaces) * [`RAGeometryCollection.IterSystemCouplingWalls()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterSystemCouplingWalls) * [`RAGeometryCollection.IterWalls()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterWalls) + * [`RAGeometryCollection.New()`](RAGeometryCollection.md#generated.RAGeometryCollection.New) + * [`RAGeometryCollection.Remove()`](RAGeometryCollection.md#generated.RAGeometryCollection.Remove) * [`RAGeometryCollection.RemoveGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.RemoveGeometry) + * [RAGridFunction](RAGridFunction.md) + * [`RAGridFunction`](RAGridFunction.md#generated.RAGridFunction) + * [`RAGridFunction.GetArray()`](RAGridFunction.md#generated.RAGridFunction.GetArray) + * [`RAGridFunction.GetAverage()`](RAGridFunction.md#generated.RAGridFunction.GetAverage) + * [`RAGridFunction.GetGrid()`](RAGridFunction.md#generated.RAGridFunction.GetGrid) + * [`RAGridFunction.GetIsStatic()`](RAGridFunction.md#generated.RAGridFunction.GetIsStatic) + * [`RAGridFunction.GetIsTransient()`](RAGridFunction.md#generated.RAGridFunction.GetIsTransient) + * [`RAGridFunction.GetLimits()`](RAGridFunction.md#generated.RAGridFunction.GetLimits) + * [`RAGridFunction.GetLocation()`](RAGridFunction.md#generated.RAGridFunction.GetLocation) + * [`RAGridFunction.GetMax()`](RAGridFunction.md#generated.RAGridFunction.GetMax) + * [`RAGridFunction.GetMin()`](RAGridFunction.md#generated.RAGridFunction.GetMin) + * [`RAGridFunction.GetStandardDeviation()`](RAGridFunction.md#generated.RAGridFunction.GetStandardDeviation) + * [`RAGridFunction.GetSum()`](RAGridFunction.md#generated.RAGridFunction.GetSum) + * [`RAGridFunction.GetSumSquared()`](RAGridFunction.md#generated.RAGridFunction.GetSumSquared) + * [`RAGridFunction.GetTimeStep()`](RAGridFunction.md#generated.RAGridFunction.GetTimeStep) + * [`RAGridFunction.GetUnit()`](RAGridFunction.md#generated.RAGridFunction.GetUnit) + * [`RAGridFunction.GetValue()`](RAGridFunction.md#generated.RAGridFunction.GetValue) + * [`RAGridFunction.GetVariance()`](RAGridFunction.md#generated.RAGridFunction.GetVariance) + * [`RAGridFunction.Modified()`](RAGridFunction.md#generated.RAGridFunction.Modified) + * [`RAGridFunction.SetCurrentTimeStep()`](RAGridFunction.md#generated.RAGridFunction.SetCurrentTimeStep) + * [`RAGridFunction.average`](RAGridFunction.md#generated.RAGridFunction.average) + * [`RAGridFunction.is_static`](RAGridFunction.md#generated.RAGridFunction.is_static) + * [`RAGridFunction.is_transient`](RAGridFunction.md#generated.RAGridFunction.is_transient) + * [`RAGridFunction.limits`](RAGridFunction.md#generated.RAGridFunction.limits) + * [`RAGridFunction.max`](RAGridFunction.md#generated.RAGridFunction.max) + * [`RAGridFunction.min`](RAGridFunction.md#generated.RAGridFunction.min) + * [`RAGridFunction.standard_deviation`](RAGridFunction.md#generated.RAGridFunction.standard_deviation) + * [`RAGridFunction.sum`](RAGridFunction.md#generated.RAGridFunction.sum) + * [`RAGridFunction.sum_squared`](RAGridFunction.md#generated.RAGridFunction.sum_squared) + * [`RAGridFunction.unit`](RAGridFunction.md#generated.RAGridFunction.unit) + * [`RAGridFunction.variance`](RAGridFunction.md#generated.RAGridFunction.variance) * [RAInletGeometry](RAInletGeometry.md) * [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry) * [`RAInletGeometry.AddCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCurve) @@ -1431,7 +1572,10 @@ * [`RAInletGeometry.GetCurveNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNames) * [`RAInletGeometry.GetCurveNamesAssociation()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNamesAssociation) * [`RAInletGeometry.GetElementCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetElementCurve) + * [`RAInletGeometry.GetFacePositions()`](RAInletGeometry.md#generated.RAInletGeometry.GetFacePositions) + * [`RAInletGeometry.GetFaceVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetFaceVertices) * [`RAInletGeometry.GetGeometryQuantity()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryQuantity) + * [`RAInletGeometry.GetGeometryTransform()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryTransform) * [`RAInletGeometry.GetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryType) * [`RAInletGeometry.GetGeometryUnit()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryUnit) * [`RAInletGeometry.GetGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunction) @@ -1448,6 +1592,7 @@ * [`RAInletGeometry.GetTimeStatistics()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStatistics) * [`RAInletGeometry.GetTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStep) * [`RAInletGeometry.GetTopologyShape()`](RAInletGeometry.md#generated.RAInletGeometry.GetTopologyShape) + * [`RAInletGeometry.GetVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetVertices) * [`RAInletGeometry.GetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.GetWidth) * [`RAInletGeometry.HasGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.HasGridFunction) * [`RAInletGeometry.IsCellActive()`](RAInletGeometry.md#generated.RAInletGeometry.IsCellActive) @@ -1469,7 +1614,6 @@ * [`RAInletGeometry.SetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.SetWidth) * [RAInletsOutletsCollection](RAInletsOutletsCollection.md) * [`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) - * [`RAInletsOutletsCollection.AddContinuousInjection()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddContinuousInjection) * [`RAInletsOutletsCollection.AddCustomInput()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddCustomInput) * [`RAInletsOutletsCollection.AddFluidInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddFluidInlet) * [`RAInletsOutletsCollection.AddOutlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddOutlet) @@ -1512,7 +1656,10 @@ * [`RAInspectorProcess.GetCurveNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNames) * [`RAInspectorProcess.GetCurveNamesAssociation()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNamesAssociation) * [`RAInspectorProcess.GetElementCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetElementCurve) + * [`RAInspectorProcess.GetFacePositions()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetFacePositions) + * [`RAInspectorProcess.GetFaceVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetFaceVertices) * [`RAInspectorProcess.GetGeometryQuantity()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryQuantity) + * [`RAInspectorProcess.GetGeometryTransform()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryTransform) * [`RAInspectorProcess.GetGeometryUnit()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryUnit) * [`RAInspectorProcess.GetGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunction) * [`RAInspectorProcess.GetGridFunctionNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunctionNames) @@ -1526,6 +1673,7 @@ * [`RAInspectorProcess.GetTimeStatistics()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStatistics) * [`RAInspectorProcess.GetTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStep) * [`RAInspectorProcess.GetTopologyShape()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTopologyShape) + * [`RAInspectorProcess.GetVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetVertices) * [`RAInspectorProcess.HasGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.HasGridFunction) * [`RAInspectorProcess.IsCellActive()`](RAInspectorProcess.md#generated.RAInspectorProcess.IsCellActive) * [`RAInspectorProcess.IterCellVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCellVertices) @@ -1574,10 +1722,8 @@ * [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) * [`RAMaterialCollection.Clear()`](RAMaterialCollection.md#generated.RAMaterialCollection.Clear) * [`RAMaterialCollection.GetBulkSolidFraction()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetBulkSolidFraction) - * [`RAMaterialCollection.GetDefaultMaterials()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetDefaultMaterials) * [`RAMaterialCollection.GetDefaultSolidMaterials()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetDefaultSolidMaterials) * [`RAMaterialCollection.GetFluidMaterial()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetFluidMaterial) - * [`RAMaterialCollection.GetMaterial()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterial) * [`RAMaterialCollection.GetMaterialsInteractionCollection()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterialsInteractionCollection) * [`RAMaterialCollection.GetSolidMaterial()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetSolidMaterial) * [`RAMaterialCollection.New()`](RAMaterialCollection.md#generated.RAMaterialCollection.New) @@ -1719,7 +1865,10 @@ * [`RAModuleOutput.GetCurveNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNames) * [`RAModuleOutput.GetCurveNamesAssociation()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNamesAssociation) * [`RAModuleOutput.GetElementCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetElementCurve) + * [`RAModuleOutput.GetFacePositions()`](RAModuleOutput.md#generated.RAModuleOutput.GetFacePositions) + * [`RAModuleOutput.GetFaceVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetFaceVertices) * [`RAModuleOutput.GetGeometryQuantity()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryQuantity) + * [`RAModuleOutput.GetGeometryTransform()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryTransform) * [`RAModuleOutput.GetGeometryUnit()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryUnit) * [`RAModuleOutput.GetGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunction) * [`RAModuleOutput.GetGridFunctionNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunctionNames) @@ -1732,6 +1881,7 @@ * [`RAModuleOutput.GetTimeStatistics()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStatistics) * [`RAModuleOutput.GetTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStep) * [`RAModuleOutput.GetTopologyShape()`](RAModuleOutput.md#generated.RAModuleOutput.GetTopologyShape) + * [`RAModuleOutput.GetVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetVertices) * [`RAModuleOutput.HasGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.HasGridFunction) * [`RAModuleOutput.IsCellActive()`](RAModuleOutput.md#generated.RAModuleOutput.IsCellActive) * [`RAModuleOutput.IterCellVertices()`](RAModuleOutput.md#generated.RAModuleOutput.IterCellVertices) @@ -1768,6 +1918,8 @@ * [`RAMotionFrame.AddCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCurve) * [`RAMotionFrame.AddCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomCurve) * [`RAMotionFrame.AddCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomProperty) + * [`RAMotionFrame.AddFreeBodyRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddFreeBodyRotationMotion) + * [`RAMotionFrame.AddFreeBodyTranslationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddFreeBodyTranslationMotion) * [`RAMotionFrame.AddGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.AddGridFunction) * [`RAMotionFrame.AddPendulumMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddPendulumMotion) * [`RAMotionFrame.AddRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddRotationMotion) @@ -1798,11 +1950,14 @@ * [`RAMotionFrame.GetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmAngularLimits) * [`RAMotionFrame.GetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmLinearLimits) * [`RAMotionFrame.GetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnablePeriodicMotion) + * [`RAMotionFrame.GetFacePositions()`](RAMotionFrame.md#generated.RAMotionFrame.GetFacePositions) + * [`RAMotionFrame.GetFaceVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetFaceVertices) * [`RAMotionFrame.GetFbmMaxAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMaxAngularLimits) * [`RAMotionFrame.GetFbmMaxLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMaxLinearLimits) * [`RAMotionFrame.GetFbmMinAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMinAngularLimits) * [`RAMotionFrame.GetFbmMinLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMinLinearLimits) * [`RAMotionFrame.GetGeometryQuantity()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryQuantity) + * [`RAMotionFrame.GetGeometryTransform()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryTransform) * [`RAMotionFrame.GetGeometryUnit()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryUnit) * [`RAMotionFrame.GetGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunction) * [`RAMotionFrame.GetGridFunctionNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunctionNames) @@ -1823,12 +1978,11 @@ * [`RAMotionFrame.GetPeriodicMotionStartTime()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionStartTime) * [`RAMotionFrame.GetPeriodicMotionStopTime()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionStopTime) * [`RAMotionFrame.GetRelativePosition()`](RAMotionFrame.md#generated.RAMotionFrame.GetRelativePosition) - * [`RAMotionFrame.GetRelativeRotationVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetRelativeRotationVector) - * [`RAMotionFrame.GetRotationAngle()`](RAMotionFrame.md#generated.RAMotionFrame.GetRotationAngle) * [`RAMotionFrame.GetTimeSet()`](RAMotionFrame.md#generated.RAMotionFrame.GetTimeSet) * [`RAMotionFrame.GetTimeStatistics()`](RAMotionFrame.md#generated.RAMotionFrame.GetTimeStatistics) * [`RAMotionFrame.GetTimeStep()`](RAMotionFrame.md#generated.RAMotionFrame.GetTimeStep) * [`RAMotionFrame.GetTopologyShape()`](RAMotionFrame.md#generated.RAMotionFrame.GetTopologyShape) + * [`RAMotionFrame.GetVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetVertices) * [`RAMotionFrame.HasGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.HasGridFunction) * [`RAMotionFrame.IsCellActive()`](RAMotionFrame.md#generated.RAMotionFrame.IsCellActive) * [`RAMotionFrame.IterCellVertices()`](RAMotionFrame.md#generated.RAMotionFrame.IterCellVertices) @@ -1859,8 +2013,6 @@ * [`RAMotionFrame.SetPeriodicMotionStartTime()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionStartTime) * [`RAMotionFrame.SetPeriodicMotionStopTime()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionStopTime) * [`RAMotionFrame.SetRelativePosition()`](RAMotionFrame.md#generated.RAMotionFrame.SetRelativePosition) - * [`RAMotionFrame.SetRelativeRotationVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetRelativeRotationVector) - * [`RAMotionFrame.SetRotationAngle()`](RAMotionFrame.md#generated.RAMotionFrame.SetRotationAngle) * [RAMotionFrameSource](RAMotionFrameSource.md) * [`RAMotionFrameSource`](RAMotionFrameSource.md#generated.RAMotionFrameSource) * [`RAMotionFrameSource.GetMotionFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.GetMotionFrame) @@ -1929,6 +2081,7 @@ * [`RAParticle.GetActivesArray()`](RAParticle.md#generated.RAParticle.GetActivesArray) * [`RAParticle.GetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) * [`RAParticle.GetAnisotropic()`](RAParticle.md#generated.RAParticle.GetAnisotropic) + * [`RAParticle.GetAssemblyCustom()`](RAParticle.md#generated.RAParticle.GetAssemblyCustom) * [`RAParticle.GetAvailableMaterials()`](RAParticle.md#generated.RAParticle.GetAvailableMaterials) * [`RAParticle.GetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetBendingAngleLimit) * [`RAParticle.GetBoundingBox()`](RAParticle.md#generated.RAParticle.GetBoundingBox) @@ -1960,9 +2113,12 @@ * [`RAParticle.GetEnableBreakage()`](RAParticle.md#generated.RAParticle.GetEnableBreakage) * [`RAParticle.GetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.GetEnableRandomAngle) * [`RAParticle.GetEnableRotations()`](RAParticle.md#generated.RAParticle.GetEnableRotations) + * [`RAParticle.GetFacePositions()`](RAParticle.md#generated.RAParticle.GetFacePositions) + * [`RAParticle.GetFaceVertices()`](RAParticle.md#generated.RAParticle.GetFaceVertices) * [`RAParticle.GetFailureRatio()`](RAParticle.md#generated.RAParticle.GetFailureRatio) * [`RAParticle.GetFlexible()`](RAParticle.md#generated.RAParticle.GetFlexible) * [`RAParticle.GetGeometryQuantity()`](RAParticle.md#generated.RAParticle.GetGeometryQuantity) + * [`RAParticle.GetGeometryTransform()`](RAParticle.md#generated.RAParticle.GetGeometryTransform) * [`RAParticle.GetGeometryUnit()`](RAParticle.md#generated.RAParticle.GetGeometryUnit) * [`RAParticle.GetGridFunction()`](RAParticle.md#generated.RAParticle.GetGridFunction) * [`RAParticle.GetGridFunctionNames()`](RAParticle.md#generated.RAParticle.GetGridFunctionNames) @@ -1997,8 +2153,6 @@ * [`RAParticle.GetRatioEnergyAfterBreakage()`](RAParticle.md#generated.RAParticle.GetRatioEnergyAfterBreakage) * [`RAParticle.GetRemeshToTarget()`](RAParticle.md#generated.RAParticle.GetRemeshToTarget) * [`RAParticle.GetRollingResistance()`](RAParticle.md#generated.RAParticle.GetRollingResistance) - * [`RAParticle.GetRotationAngle()`](RAParticle.md#generated.RAParticle.GetRotationAngle) - * [`RAParticle.GetRotationVector()`](RAParticle.md#generated.RAParticle.GetRotationVector) * [`RAParticle.GetSecondBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetSecondBendingAngleLimit) * [`RAParticle.GetShape()`](RAParticle.md#generated.RAParticle.GetShape) * [`RAParticle.GetShearStressLimit()`](RAParticle.md#generated.RAParticle.GetShearStressLimit) @@ -2037,6 +2191,7 @@ * [`RAParticle.GetValidSizeTypeValues()`](RAParticle.md#generated.RAParticle.GetValidSizeTypeValues) * [`RAParticle.GetValidT10FormulaValues()`](RAParticle.md#generated.RAParticle.GetValidT10FormulaValues) * [`RAParticle.GetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.GetVerticalAspectRatio) + * [`RAParticle.GetVertices()`](RAParticle.md#generated.RAParticle.GetVertices) * [`RAParticle.GetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.GetVonMisesStressLimit) * [`RAParticle.GetWithFailure()`](RAParticle.md#generated.RAParticle.GetWithFailure) * [`RAParticle.GetXDirection()`](RAParticle.md#generated.RAParticle.GetXDirection) @@ -2044,7 +2199,6 @@ * [`RAParticle.GetZDirection()`](RAParticle.md#generated.RAParticle.GetZDirection) * [`RAParticle.HasGridFunction()`](RAParticle.md#generated.RAParticle.HasGridFunction) * [`RAParticle.ImportCustomFiber()`](RAParticle.md#generated.RAParticle.ImportCustomFiber) - * [`RAParticle.ImportFiberFromTXT()`](RAParticle.md#generated.RAParticle.ImportFiberFromTXT) * [`RAParticle.ImportFromSTL()`](RAParticle.md#generated.RAParticle.ImportFromSTL) * [`RAParticle.IsBreakageEnabled()`](RAParticle.md#generated.RAParticle.IsBreakageEnabled) * [`RAParticle.IsCellActive()`](RAParticle.md#generated.RAParticle.IsCellActive) @@ -2110,8 +2264,6 @@ * [`RAParticle.SetRatioEnergyAfterBreakage()`](RAParticle.md#generated.RAParticle.SetRatioEnergyAfterBreakage) * [`RAParticle.SetRemeshToTarget()`](RAParticle.md#generated.RAParticle.SetRemeshToTarget) * [`RAParticle.SetRollingResistance()`](RAParticle.md#generated.RAParticle.SetRollingResistance) - * [`RAParticle.SetRotationAngle()`](RAParticle.md#generated.RAParticle.SetRotationAngle) - * [`RAParticle.SetRotationVector()`](RAParticle.md#generated.RAParticle.SetRotationVector) * [`RAParticle.SetSecondBendingAngleLimit()`](RAParticle.md#generated.RAParticle.SetSecondBendingAngleLimit) * [`RAParticle.SetShape()`](RAParticle.md#generated.RAParticle.SetShape) * [`RAParticle.SetShearStressLimit()`](RAParticle.md#generated.RAParticle.SetShearStressLimit) @@ -2176,47 +2328,41 @@ * [`RAParticleCollection.Remove()`](RAParticleCollection.md#generated.RAParticleCollection.Remove) * [RAParticleInlet](RAParticleInlet.md) * [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) + * [`RAParticleInlet.AddParticle()`](RAParticleInlet.md#generated.RAParticleInlet.AddParticle) * [`RAParticleInlet.DisableForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.DisableForcePacking) * [`RAParticleInlet.DisablePeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.DisablePeriodic) - * [`RAParticleInlet.DisablePeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.DisablePeriodicDischarge) * [`RAParticleInlet.DisableStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.DisableStopAllAtStopTime) * [`RAParticleInlet.DisableUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.DisableUseTargetNormalVelocity) * [`RAParticleInlet.EnableForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.EnableForcePacking) * [`RAParticleInlet.EnablePeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.EnablePeriodic) - * [`RAParticleInlet.EnablePeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.EnablePeriodicDischarge) * [`RAParticleInlet.EnableStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.EnableStopAllAtStopTime) * [`RAParticleInlet.EnableUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.EnableUseTargetNormalVelocity) * [`RAParticleInlet.GetAvailableEntryPoints()`](RAParticleInlet.md#generated.RAParticleInlet.GetAvailableEntryPoints) - * [`RAParticleInlet.GetDischargeTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetDischargeTime) * [`RAParticleInlet.GetEntryPoint()`](RAParticleInlet.md#generated.RAParticleInlet.GetEntryPoint) * [`RAParticleInlet.GetForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.GetForcePacking) * [`RAParticleInlet.GetInjectionDuration()`](RAParticleInlet.md#generated.RAParticleInlet.GetInjectionDuration) * [`RAParticleInlet.GetInputPropertiesList()`](RAParticleInlet.md#generated.RAParticleInlet.GetInputPropertiesList) * [`RAParticleInlet.GetPeriod()`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriod) * [`RAParticleInlet.GetPeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriodic) - * [`RAParticleInlet.GetPeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriodicDischarge) * [`RAParticleInlet.GetSphInjectionEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.GetSphInjectionEnabled) * [`RAParticleInlet.GetSphTemperature()`](RAParticleInlet.md#generated.RAParticleInlet.GetSphTemperature) * [`RAParticleInlet.GetStartTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetStartTime) * [`RAParticleInlet.GetStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetStopAllAtStopTime) * [`RAParticleInlet.GetStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetStopTime) * [`RAParticleInlet.GetTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.GetTargetNormalVelocity) - * [`RAParticleInlet.GetTonnageList()`](RAParticleInlet.md#generated.RAParticleInlet.GetTonnageList) * [`RAParticleInlet.GetUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.GetUseTargetNormalVelocity) * [`RAParticleInlet.GetUxLocal()`](RAParticleInlet.md#generated.RAParticleInlet.GetUxLocal) * [`RAParticleInlet.GetUzLocal()`](RAParticleInlet.md#generated.RAParticleInlet.GetUzLocal) * [`RAParticleInlet.IsForcePackingEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsForcePackingEnabled) - * [`RAParticleInlet.IsPeriodicDischargeEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsPeriodicDischargeEnabled) * [`RAParticleInlet.IsPeriodicEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsPeriodicEnabled) * [`RAParticleInlet.IsStopAllAtStopTimeEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsStopAllAtStopTimeEnabled) * [`RAParticleInlet.IsUseTargetNormalVelocityEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsUseTargetNormalVelocityEnabled) - * [`RAParticleInlet.SetDischargeTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetDischargeTime) + * [`RAParticleInlet.RemoveParticle()`](RAParticleInlet.md#generated.RAParticleInlet.RemoveParticle) * [`RAParticleInlet.SetEntryPoint()`](RAParticleInlet.md#generated.RAParticleInlet.SetEntryPoint) * [`RAParticleInlet.SetForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.SetForcePacking) * [`RAParticleInlet.SetInjectionDuration()`](RAParticleInlet.md#generated.RAParticleInlet.SetInjectionDuration) * [`RAParticleInlet.SetPeriod()`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriod) * [`RAParticleInlet.SetPeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriodic) - * [`RAParticleInlet.SetPeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriodicDischarge) * [`RAParticleInlet.SetSphInjectionEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.SetSphInjectionEnabled) * [`RAParticleInlet.SetSphTemperature()`](RAParticleInlet.md#generated.RAParticleInlet.SetSphTemperature) * [`RAParticleInlet.SetStartTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStartTime) @@ -2234,13 +2380,11 @@ * [`RAParticleInletProperties.GetModuleProperty()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetModuleProperty) * [`RAParticleInletProperties.GetParticle()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetParticle) * [`RAParticleInletProperties.GetTemperature()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetTemperature) - * [`RAParticleInletProperties.GetTonnage()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetTonnage) * [`RAParticleInletProperties.GetValidOptionsForModuleProperty()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetValidOptionsForModuleProperty) * [`RAParticleInletProperties.SetMassFlowRate()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetMassFlowRate) * [`RAParticleInletProperties.SetModuleProperty()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetModuleProperty) * [`RAParticleInletProperties.SetParticle()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetParticle) * [`RAParticleInletProperties.SetTemperature()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetTemperature) - * [`RAParticleInletProperties.SetTonnage()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetTonnage) * [RAParticleInletPropertiesList](RAParticleInletPropertiesList.md) * [`RAParticleInletPropertiesList`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList) * [`RAParticleInletPropertiesList.Clear()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.Clear) @@ -2276,7 +2420,10 @@ * [`RAParticleJointsData.GetCurveNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNames) * [`RAParticleJointsData.GetCurveNamesAssociation()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNamesAssociation) * [`RAParticleJointsData.GetElementCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetElementCurve) + * [`RAParticleJointsData.GetFacePositions()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetFacePositions) + * [`RAParticleJointsData.GetFaceVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetFaceVertices) * [`RAParticleJointsData.GetGeometryQuantity()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryQuantity) + * [`RAParticleJointsData.GetGeometryTransform()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryTransform) * [`RAParticleJointsData.GetGeometryUnit()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryUnit) * [`RAParticleJointsData.GetGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunction) * [`RAParticleJointsData.GetGridFunctionNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunctionNames) @@ -2289,6 +2436,7 @@ * [`RAParticleJointsData.GetTimeStatistics()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStatistics) * [`RAParticleJointsData.GetTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStep) * [`RAParticleJointsData.GetTopologyShape()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTopologyShape) + * [`RAParticleJointsData.GetVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetVertices) * [`RAParticleJointsData.HasGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.HasGridFunction) * [`RAParticleJointsData.IsCellActive()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCellActive) * [`RAParticleJointsData.IsCollectJointDataEnabled()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCollectJointDataEnabled) @@ -2328,7 +2476,10 @@ * [`RAParticleTimeSelectionProcess.GetCurveNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNames) * [`RAParticleTimeSelectionProcess.GetCurveNamesAssociation()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation) * [`RAParticleTimeSelectionProcess.GetElementCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetElementCurve) + * [`RAParticleTimeSelectionProcess.GetFacePositions()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetFacePositions) + * [`RAParticleTimeSelectionProcess.GetFaceVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetFaceVertices) * [`RAParticleTimeSelectionProcess.GetGeometryQuantity()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity) + * [`RAParticleTimeSelectionProcess.GetGeometryTransform()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryTransform) * [`RAParticleTimeSelectionProcess.GetGeometryUnit()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryUnit) * [`RAParticleTimeSelectionProcess.GetGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunction) * [`RAParticleTimeSelectionProcess.GetGridFunctionNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames) @@ -2343,6 +2494,7 @@ * [`RAParticleTimeSelectionProcess.GetTimeStatistics()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStatistics) * [`RAParticleTimeSelectionProcess.GetTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStep) * [`RAParticleTimeSelectionProcess.GetTopologyShape()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTopologyShape) + * [`RAParticleTimeSelectionProcess.GetVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetVertices) * [`RAParticleTimeSelectionProcess.HasGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.HasGridFunction) * [`RAParticleTimeSelectionProcess.IsCellActive()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IsCellActive) * [`RAParticleTimeSelectionProcess.IterCellVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCellVertices) @@ -2383,7 +2535,10 @@ * [`RAParticleToContactProcess.GetCurveNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNames) * [`RAParticleToContactProcess.GetCurveNamesAssociation()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNamesAssociation) * [`RAParticleToContactProcess.GetElementCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetElementCurve) + * [`RAParticleToContactProcess.GetFacePositions()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetFacePositions) + * [`RAParticleToContactProcess.GetFaceVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetFaceVertices) * [`RAParticleToContactProcess.GetGeometryQuantity()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryQuantity) + * [`RAParticleToContactProcess.GetGeometryTransform()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryTransform) * [`RAParticleToContactProcess.GetGeometryUnit()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryUnit) * [`RAParticleToContactProcess.GetGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunction) * [`RAParticleToContactProcess.GetGridFunctionNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunctionNames) @@ -2397,6 +2552,7 @@ * [`RAParticleToContactProcess.GetTimeStatistics()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStatistics) * [`RAParticleToContactProcess.GetTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStep) * [`RAParticleToContactProcess.GetTopologyShape()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTopologyShape) + * [`RAParticleToContactProcess.GetVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetVertices) * [`RAParticleToContactProcess.HasGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.HasGridFunction) * [`RAParticleToContactProcess.IsCellActive()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IsCellActive) * [`RAParticleToContactProcess.IterCellVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCellVertices) @@ -2435,7 +2591,10 @@ * [`RAParticles.GetCurveNames()`](RAParticles.md#generated.RAParticles.GetCurveNames) * [`RAParticles.GetCurveNamesAssociation()`](RAParticles.md#generated.RAParticles.GetCurveNamesAssociation) * [`RAParticles.GetElementCurve()`](RAParticles.md#generated.RAParticles.GetElementCurve) + * [`RAParticles.GetFacePositions()`](RAParticles.md#generated.RAParticles.GetFacePositions) + * [`RAParticles.GetFaceVertices()`](RAParticles.md#generated.RAParticles.GetFaceVertices) * [`RAParticles.GetGeometryQuantity()`](RAParticles.md#generated.RAParticles.GetGeometryQuantity) + * [`RAParticles.GetGeometryTransform()`](RAParticles.md#generated.RAParticles.GetGeometryTransform) * [`RAParticles.GetGeometryUnit()`](RAParticles.md#generated.RAParticles.GetGeometryUnit) * [`RAParticles.GetGridFunction()`](RAParticles.md#generated.RAParticles.GetGridFunction) * [`RAParticles.GetGridFunctionNames()`](RAParticles.md#generated.RAParticles.GetGridFunctionNames) @@ -2449,6 +2608,7 @@ * [`RAParticles.GetTimeStatistics()`](RAParticles.md#generated.RAParticles.GetTimeStatistics) * [`RAParticles.GetTimeStep()`](RAParticles.md#generated.RAParticles.GetTimeStep) * [`RAParticles.GetTopologyShape()`](RAParticles.md#generated.RAParticles.GetTopologyShape) + * [`RAParticles.GetVertices()`](RAParticles.md#generated.RAParticles.GetVertices) * [`RAParticles.HasGridFunction()`](RAParticles.md#generated.RAParticles.HasGridFunction) * [`RAParticles.IsCellActive()`](RAParticles.md#generated.RAParticles.IsCellActive) * [`RAParticles.IterCellVertices()`](RAParticles.md#generated.RAParticles.IterCellVertices) @@ -2528,6 +2688,28 @@ * [`RAPhysics.SetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetUpdateDistanceMultiplier) * [`RAPhysics.SetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.SetUseRadlEtAl) * [`RAPhysics.SetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.SetVolumeFractionLimit) + * [RAPlaneGroup](RAPlaneGroup.md) + * [`RAPlaneGroup`](RAPlaneGroup.md#generated.RAPlaneGroup) + * [`RAPlaneGroup.AddCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.AddCurve) + * [`RAPlaneGroup.GetCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetCurve) + * [`RAPlaneGroup.GetCurveNames()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetCurveNames) + * [`RAPlaneGroup.GetCurveNamesAssociation()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetCurveNamesAssociation) + * [`RAPlaneGroup.GetElementCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetElementCurve) + * [`RAPlaneGroup.GetMode()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetMode) + * [`RAPlaneGroup.GetNumpyCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetNumpyCurve) + * [`RAPlaneGroup.GetOrientation()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientation) + * [`RAPlaneGroup.GetOrientationFromAngleAndVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientationFromAngleAndVector) + * [`RAPlaneGroup.GetOrientationFromAngles()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientationFromAngles) + * [`RAPlaneGroup.GetOrientationFromBasisVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientationFromBasisVector) + * [`RAPlaneGroup.GetOrigin()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrigin) + * [`RAPlaneGroup.GetType()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetType) + * [`RAPlaneGroup.SetMode()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetMode) + * [`RAPlaneGroup.SetOrientation()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientation) + * [`RAPlaneGroup.SetOrientationFromAngleAndVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientationFromAngleAndVector) + * [`RAPlaneGroup.SetOrientationFromAngles()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientationFromAngles) + * [`RAPlaneGroup.SetOrientationFromBasisVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientationFromBasisVector) + * [`RAPlaneGroup.SetOrigin()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrigin) + * [`RAPlaneGroup.SetType()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetType) * [RAPlaneProcess](RAPlaneProcess.md) * [`RAPlaneProcess`](RAPlaneProcess.md#generated.RAPlaneProcess) * [`RAPlaneProcess.AddCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCurve) @@ -2555,13 +2737,15 @@ * [`RAPlaneProcess.GetCurveNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNames) * [`RAPlaneProcess.GetCurveNamesAssociation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNamesAssociation) * [`RAPlaneProcess.GetElementCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetElementCurve) + * [`RAPlaneProcess.GetFacePositions()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetFacePositions) + * [`RAPlaneProcess.GetFaceVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetFaceVertices) * [`RAPlaneProcess.GetGeometryQuantity()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryQuantity) + * [`RAPlaneProcess.GetGeometryTransform()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryTransform) * [`RAPlaneProcess.GetGeometryUnit()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryUnit) * [`RAPlaneProcess.GetGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGridFunction) * [`RAPlaneProcess.GetGridFunctionNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGridFunctionNames) * [`RAPlaneProcess.GetMeshColoring()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetMeshColoring) * [`RAPlaneProcess.GetMode()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetMode) - * [`RAPlaneProcess.GetNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNormal) * [`RAPlaneProcess.GetNumberOfCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumberOfCells) * [`RAPlaneProcess.GetNumberOfNodes()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumberOfNodes) * [`RAPlaneProcess.GetNumberOfParticles()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumberOfParticles) @@ -2572,13 +2756,13 @@ * [`RAPlaneProcess.GetOrientationFromBasisVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromBasisVector) * [`RAPlaneProcess.GetOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrigin) * [`RAPlaneProcess.GetOutputVariableValue()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOutputVariableValue) - * [`RAPlaneProcess.GetPlaneNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetPlaneNormal) - * [`RAPlaneProcess.GetPlaneOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetPlaneOrigin) + * [`RAPlaneProcess.GetRelativeRotationVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetRelativeRotationVector) * [`RAPlaneProcess.GetTimeSet()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTimeSet) * [`RAPlaneProcess.GetTimeStatistics()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTimeStatistics) * [`RAPlaneProcess.GetTimeStep()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTimeStep) * [`RAPlaneProcess.GetTopologyShape()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTopologyShape) * [`RAPlaneProcess.GetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetType) + * [`RAPlaneProcess.GetVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetVertices) * [`RAPlaneProcess.HasGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.HasGridFunction) * [`RAPlaneProcess.IsCellActive()`](RAPlaneProcess.md#generated.RAPlaneProcess.IsCellActive) * [`RAPlaneProcess.IterCellVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCellVertices) @@ -2591,14 +2775,12 @@ * [`RAPlaneProcess.RemoveProcess()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveProcess) * [`RAPlaneProcess.SetCurrentTimeStep()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetCurrentTimeStep) * [`RAPlaneProcess.SetMode()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetMode) - * [`RAPlaneProcess.SetNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetNormal) * [`RAPlaneProcess.SetOrientation()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientation) * [`RAPlaneProcess.SetOrientationFromAngleAndVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientationFromAngleAndVector) * [`RAPlaneProcess.SetOrientationFromAngles()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientationFromAngles) * [`RAPlaneProcess.SetOrientationFromBasisVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientationFromBasisVector) * [`RAPlaneProcess.SetOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrigin) - * [`RAPlaneProcess.SetPlaneNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetPlaneNormal) - * [`RAPlaneProcess.SetPlaneOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetPlaneOrigin) + * [`RAPlaneProcess.SetRelativeRotationVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetRelativeRotationVector) * [`RAPlaneProcess.SetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetType) * [RAPointCloud](RAPointCloud.md) * [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud) @@ -2630,8 +2812,11 @@ * [`RAPointCloud.GetCurveNamesAssociation()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNamesAssociation) * [`RAPointCloud.GetElementCurve()`](RAPointCloud.md#generated.RAPointCloud.GetElementCurve) * [`RAPointCloud.GetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.GetEnablePeriodic) + * [`RAPointCloud.GetFacePositions()`](RAPointCloud.md#generated.RAPointCloud.GetFacePositions) + * [`RAPointCloud.GetFaceVertices()`](RAPointCloud.md#generated.RAPointCloud.GetFaceVertices) * [`RAPointCloud.GetFilePath()`](RAPointCloud.md#generated.RAPointCloud.GetFilePath) * [`RAPointCloud.GetGeometryQuantity()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryQuantity) + * [`RAPointCloud.GetGeometryTransform()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryTransform) * [`RAPointCloud.GetGeometryUnit()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryUnit) * [`RAPointCloud.GetGridFunction()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunction) * [`RAPointCloud.GetGridFunctionNames()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunctionNames) @@ -2646,11 +2831,13 @@ * [`RAPointCloud.GetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStartTime) * [`RAPointCloud.GetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStopTime) * [`RAPointCloud.GetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOff) + * [`RAPointCloud.GetSearchCutOffDistance()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOffDistance) * [`RAPointCloud.GetTimeSet()`](RAPointCloud.md#generated.RAPointCloud.GetTimeSet) * [`RAPointCloud.GetTimeStatistics()`](RAPointCloud.md#generated.RAPointCloud.GetTimeStatistics) * [`RAPointCloud.GetTimeStep()`](RAPointCloud.md#generated.RAPointCloud.GetTimeStep) * [`RAPointCloud.GetTopologyShape()`](RAPointCloud.md#generated.RAPointCloud.GetTopologyShape) * [`RAPointCloud.GetValidOptionsForModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.GetValidOptionsForModuleProperty) + * [`RAPointCloud.GetVertices()`](RAPointCloud.md#generated.RAPointCloud.GetVertices) * [`RAPointCloud.HasGridFunction()`](RAPointCloud.md#generated.RAPointCloud.HasGridFunction) * [`RAPointCloud.IsCellActive()`](RAPointCloud.md#generated.RAPointCloud.IsCellActive) * [`RAPointCloud.IsPeriodicEnabled()`](RAPointCloud.md#generated.RAPointCloud.IsPeriodicEnabled) @@ -2670,6 +2857,7 @@ * [`RAPointCloud.SetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStartTime) * [`RAPointCloud.SetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStopTime) * [`RAPointCloud.SetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOff) + * [`RAPointCloud.SetSearchCutOffDistance()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOffDistance) * [RAPointCloudCollection](RAPointCloudCollection.md) * [`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) * [`RAPointCloudCollection.Clear()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Clear) @@ -2704,7 +2892,10 @@ * [`RAPolyhedronProcess.GetCurveNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNames) * [`RAPolyhedronProcess.GetCurveNamesAssociation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNamesAssociation) * [`RAPolyhedronProcess.GetElementCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetElementCurve) + * [`RAPolyhedronProcess.GetFacePositions()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetFacePositions) + * [`RAPolyhedronProcess.GetFaceVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetFaceVertices) * [`RAPolyhedronProcess.GetGeometryQuantity()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryQuantity) + * [`RAPolyhedronProcess.GetGeometryTransform()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryTransform) * [`RAPolyhedronProcess.GetGeometryUnit()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryUnit) * [`RAPolyhedronProcess.GetGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunction) * [`RAPolyhedronProcess.GetGridFunctionNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunctionNames) @@ -2719,13 +2910,12 @@ * [`RAPolyhedronProcess.GetOrientationFromAngles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromAngles) * [`RAPolyhedronProcess.GetOrientationFromBasisVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromBasisVector) * [`RAPolyhedronProcess.GetOutputVariableValue()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOutputVariableValue) - * [`RAPolyhedronProcess.GetRotation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetRotation) * [`RAPolyhedronProcess.GetScale()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetScale) - * [`RAPolyhedronProcess.GetSize()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetSize) * [`RAPolyhedronProcess.GetTimeSet()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTimeSet) * [`RAPolyhedronProcess.GetTimeStatistics()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTimeStatistics) * [`RAPolyhedronProcess.GetTimeStep()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTimeStep) * [`RAPolyhedronProcess.GetTopologyShape()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTopologyShape) + * [`RAPolyhedronProcess.GetVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetVertices) * [`RAPolyhedronProcess.HasGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.HasGridFunction) * [`RAPolyhedronProcess.IsCellActive()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IsCellActive) * [`RAPolyhedronProcess.IterCellVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCellVertices) @@ -2743,10 +2933,8 @@ * [`RAPolyhedronProcess.SetOrientationFromAngleAndVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientationFromAngleAndVector) * [`RAPolyhedronProcess.SetOrientationFromAngles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientationFromAngles) * [`RAPolyhedronProcess.SetOrientationFromBasisVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientationFromBasisVector) - * [`RAPolyhedronProcess.SetRotation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetRotation) * [`RAPolyhedronProcess.SetSTL()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetSTL) * [`RAPolyhedronProcess.SetScale()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetScale) - * [`RAPolyhedronProcess.SetSize()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetSize) * [RAPrescribedForce](RAPrescribedForce.md) * [`RAPrescribedForce`](RAPrescribedForce.md#generated.RAPrescribedForce) * [`RAPrescribedForce.GetForceValue()`](RAPrescribedForce.md#generated.RAPrescribedForce.GetForceValue) @@ -2767,6 +2955,7 @@ * [`RAProject.GetStudy()`](RAProject.md#generated.RAProject.GetStudy) * [`RAProject.GetTimeFilter()`](RAProject.md#generated.RAProject.GetTimeFilter) * [`RAProject.GetUserProcessCollection()`](RAProject.md#generated.RAProject.GetUserProcessCollection) + * [`RAProject.HasUnsavedChanges()`](RAProject.md#generated.RAProject.HasUnsavedChanges) * [`RAProject.RemoveProcess()`](RAProject.md#generated.RAProject.RemoveProcess) * [`RAProject.SaveProject()`](RAProject.md#generated.RAProject.SaveProject) * [`RAProject.SaveProjectForRestart()`](RAProject.md#generated.RAProject.SaveProjectForRestart) @@ -2796,6 +2985,7 @@ * [`RAReceivingConveyor.GetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltThickness) * [`RAReceivingConveyor.GetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltWidth) * [`RAReceivingConveyor.GetBoundingBox()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBoundingBox) + * [`RAReceivingConveyor.GetCapillaryFrictionCoefficient()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCapillaryFrictionCoefficient) * [`RAReceivingConveyor.GetCellAreaAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellAreaAsArray) * [`RAReceivingConveyor.GetCellCenterAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellCenterAsArray) * [`RAReceivingConveyor.GetCellDzAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellDzAsArray) @@ -2809,7 +2999,10 @@ * [`RAReceivingConveyor.GetCurveNamesAssociation()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNamesAssociation) * [`RAReceivingConveyor.GetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetDecelerationPeriod) * [`RAReceivingConveyor.GetElementCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetElementCurve) + * [`RAReceivingConveyor.GetFacePositions()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetFacePositions) + * [`RAReceivingConveyor.GetFaceVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetFaceVertices) * [`RAReceivingConveyor.GetGeometryQuantity()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryQuantity) + * [`RAReceivingConveyor.GetGeometryTransform()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryTransform) * [`RAReceivingConveyor.GetGeometryUnit()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryUnit) * [`RAReceivingConveyor.GetGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunction) * [`RAReceivingConveyor.GetGridFunctionNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunctionNames) @@ -2843,6 +3036,7 @@ * [`RAReceivingConveyor.GetValidSphBoundaryTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues) * [`RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues) * [`RAReceivingConveyor.GetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVerticalOffset) + * [`RAReceivingConveyor.GetVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVertices) * [`RAReceivingConveyor.GetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetWidth) * [`RAReceivingConveyor.HasGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.HasGridFunction) * [`RAReceivingConveyor.IsCellActive()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IsCellActive) @@ -2862,6 +3056,7 @@ * [`RAReceivingConveyor.SetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltSpeed) * [`RAReceivingConveyor.SetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltThickness) * [`RAReceivingConveyor.SetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltWidth) + * [`RAReceivingConveyor.SetCapillaryFrictionCoefficient()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCapillaryFrictionCoefficient) * [`RAReceivingConveyor.SetCurrentTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCurrentTimeStep) * [`RAReceivingConveyor.SetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetDecelerationPeriod) * [`RAReceivingConveyor.SetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHeightOffset) @@ -2909,12 +3104,16 @@ * [`RARectangularSurface.GetCurveNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNames) * [`RARectangularSurface.GetCurveNamesAssociation()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNamesAssociation) * [`RARectangularSurface.GetElementCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetElementCurve) + * [`RARectangularSurface.GetFacePositions()`](RARectangularSurface.md#generated.RARectangularSurface.GetFacePositions) + * [`RARectangularSurface.GetFaceVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetFaceVertices) * [`RARectangularSurface.GetGeometryQuantity()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryQuantity) + * [`RARectangularSurface.GetGeometryTransform()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryTransform) * [`RARectangularSurface.GetGeometryUnit()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryUnit) * [`RARectangularSurface.GetGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.GetGridFunction) * [`RARectangularSurface.GetGridFunctionNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetGridFunctionNames) * [`RARectangularSurface.GetLength()`](RARectangularSurface.md#generated.RARectangularSurface.GetLength) * [`RARectangularSurface.GetMeshColoring()`](RARectangularSurface.md#generated.RARectangularSurface.GetMeshColoring) + * [`RARectangularSurface.GetMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.GetMotionFrame) * [`RARectangularSurface.GetNumberOfCells()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfCells) * [`RARectangularSurface.GetNumberOfNodes()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfNodes) * [`RARectangularSurface.GetNumpyCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumpyCurve) @@ -2927,6 +3126,7 @@ * [`RARectangularSurface.GetTimeStatistics()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStatistics) * [`RARectangularSurface.GetTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStep) * [`RARectangularSurface.GetTopologyShape()`](RARectangularSurface.md#generated.RARectangularSurface.GetTopologyShape) + * [`RARectangularSurface.GetVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetVertices) * [`RARectangularSurface.GetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.GetWidth) * [`RARectangularSurface.HasGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.HasGridFunction) * [`RARectangularSurface.HasMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.HasMotionFrame) @@ -2941,6 +3141,7 @@ * [`RARectangularSurface.SetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.SetCenter) * [`RARectangularSurface.SetCurrentTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.SetCurrentTimeStep) * [`RARectangularSurface.SetLength()`](RARectangularSurface.md#generated.RARectangularSurface.SetLength) + * [`RARectangularSurface.SetMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.SetMotionFrame) * [`RARectangularSurface.SetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientation) * [`RARectangularSurface.SetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngleAndVector) * [`RARectangularSurface.SetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngles) @@ -2975,7 +3176,10 @@ * [`RARegionOfInterestCube.GetCurveNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNames) * [`RARegionOfInterestCube.GetCurveNamesAssociation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNamesAssociation) * [`RARegionOfInterestCube.GetElementCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetElementCurve) + * [`RARegionOfInterestCube.GetFacePositions()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetFacePositions) + * [`RARegionOfInterestCube.GetFaceVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetFaceVertices) * [`RARegionOfInterestCube.GetGeometryQuantity()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryQuantity) + * [`RARegionOfInterestCube.GetGeometryTransform()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryTransform) * [`RARegionOfInterestCube.GetGeometryUnit()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryUnit) * [`RARegionOfInterestCube.GetGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunction) * [`RARegionOfInterestCube.GetGridFunctionNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunctionNames) @@ -2994,6 +3198,7 @@ * [`RARegionOfInterestCube.GetTimeStatistics()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStatistics) * [`RARegionOfInterestCube.GetTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStep) * [`RARegionOfInterestCube.GetTopologyShape()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTopologyShape) + * [`RARegionOfInterestCube.GetVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetVertices) * [`RARegionOfInterestCube.HasGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.HasGridFunction) * [`RARegionOfInterestCube.IsCellActive()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IsCellActive) * [`RARegionOfInterestCube.IterCellVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCellVertices) @@ -3040,8 +3245,11 @@ * [`RARegionOfInterestCylinder.GetCurveNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNames) * [`RARegionOfInterestCylinder.GetCurveNamesAssociation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation) * [`RARegionOfInterestCylinder.GetElementCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetElementCurve) + * [`RARegionOfInterestCylinder.GetFacePositions()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFacePositions) + * [`RARegionOfInterestCylinder.GetFaceVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFaceVertices) * [`RARegionOfInterestCylinder.GetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFinalAngle) * [`RARegionOfInterestCylinder.GetGeometryQuantity()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryQuantity) + * [`RARegionOfInterestCylinder.GetGeometryTransform()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryTransform) * [`RARegionOfInterestCylinder.GetGeometryUnit()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryUnit) * [`RARegionOfInterestCylinder.GetGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunction) * [`RARegionOfInterestCylinder.GetGridFunctionNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunctionNames) @@ -3063,6 +3271,7 @@ * [`RARegionOfInterestCylinder.GetTimeStatistics()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStatistics) * [`RARegionOfInterestCylinder.GetTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStep) * [`RARegionOfInterestCylinder.GetTopologyShape()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTopologyShape) + * [`RARegionOfInterestCylinder.GetVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetVertices) * [`RARegionOfInterestCylinder.HasGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.HasGridFunction) * [`RARegionOfInterestCylinder.IsCellActive()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IsCellActive) * [`RARegionOfInterestCylinder.IterCellVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCellVertices) @@ -3117,16 +3326,17 @@ * [`RASPHSettings.CreateGridFunctionStatisticOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable) * [`RASPHSettings.CreateTransientCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateTransientCurveOutputVariable) * [`RASPHSettings.DisableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.DisableEulerianSolution) + * [`RASPHSettings.DisableRelaxedIncompressibilityConstraint()`](RASPHSettings.md#generated.RASPHSettings.DisableRelaxedIncompressibilityConstraint) * [`RASPHSettings.DisableShepardFilterOnDensity()`](RASPHSettings.md#generated.RASPHSettings.DisableShepardFilterOnDensity) * [`RASPHSettings.DisableShepardFilterOnPressure()`](RASPHSettings.md#generated.RASPHSettings.DisableShepardFilterOnPressure) * [`RASPHSettings.EditCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.EditCustomCurve) * [`RASPHSettings.EditCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.EditCustomProperty) * [`RASPHSettings.EnableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.EnableEulerianSolution) + * [`RASPHSettings.EnableRelaxedIncompressibilityConstraint()`](RASPHSettings.md#generated.RASPHSettings.EnableRelaxedIncompressibilityConstraint) * [`RASPHSettings.EnableShepardFilterOnDensity()`](RASPHSettings.md#generated.RASPHSettings.EnableShepardFilterOnDensity) * [`RASPHSettings.EnableShepardFilterOnPressure()`](RASPHSettings.md#generated.RASPHSettings.EnableShepardFilterOnPressure) * [`RASPHSettings.GetActivesArray()`](RASPHSettings.md#generated.RASPHSettings.GetActivesArray) * [`RASPHSettings.GetAvailableFluidMaterials()`](RASPHSettings.md#generated.RASPHSettings.GetAvailableFluidMaterials) - * [`RASPHSettings.GetBackgroundPressure()`](RASPHSettings.md#generated.RASPHSettings.GetBackgroundPressure) * [`RASPHSettings.GetBoundingBox()`](RASPHSettings.md#generated.RASPHSettings.GetBoundingBox) * [`RASPHSettings.GetCS()`](RASPHSettings.md#generated.RASPHSettings.GetCS) * [`RASPHSettings.GetCellAreaAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellAreaAsArray) @@ -3148,13 +3358,18 @@ * [`RASPHSettings.GetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorNorm) * [`RASPHSettings.GetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorTang) * [`RASPHSettings.GetElementCurve()`](RASPHSettings.md#generated.RASPHSettings.GetElementCurve) + * [`RASPHSettings.GetEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEnabled) * [`RASPHSettings.GetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEulerianSolutionEnabled) + * [`RASPHSettings.GetFacePositions()`](RASPHSettings.md#generated.RASPHSettings.GetFacePositions) + * [`RASPHSettings.GetFaceVertices()`](RASPHSettings.md#generated.RASPHSettings.GetFaceVertices) * [`RASPHSettings.GetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.GetFluidMaterial) * [`RASPHSettings.GetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit) * [`RASPHSettings.GetGeometryQuantity()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryQuantity) + * [`RASPHSettings.GetGeometryTransform()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryTransform) * [`RASPHSettings.GetGeometryUnit()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryUnit) * [`RASPHSettings.GetGridFunction()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunction) * [`RASPHSettings.GetGridFunctionNames()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunctionNames) + * [`RASPHSettings.GetIncompressibilityRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetIncompressibilityRelaxationFactor) * [`RASPHSettings.GetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetKernelDistFactor) * [`RASPHSettings.GetKernelType()`](RASPHSettings.md#generated.RASPHSettings.GetKernelType) * [`RASPHSettings.GetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.GetLimitTurbulentViscosity) @@ -3172,6 +3387,7 @@ * [`RASPHSettings.GetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.GetPosCorrectionType) * [`RASPHSettings.GetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.GetPressureDeg) * [`RASPHSettings.GetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetPressureUnderRelaxationFactor) + * [`RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled) * [`RASPHSettings.GetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) * [`RASPHSettings.GetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) * [`RASPHSettings.GetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.GetShiftingFactor) @@ -3204,11 +3420,18 @@ * [`RASPHSettings.GetValidSurfaceTensionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSurfaceTensionTypeValues) * [`RASPHSettings.GetValidTurbulenceTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidTurbulenceTypeValues) * [`RASPHSettings.GetValidViscosityTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscosityTypeValues) + * [`RASPHSettings.GetValidViscousForceIntegrationValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscousForceIntegrationValues) + * [`RASPHSettings.GetVertices()`](RASPHSettings.md#generated.RASPHSettings.GetVertices) * [`RASPHSettings.GetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.GetViscosityType) + * [`RASPHSettings.GetViscousForceIntegration()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceIntegration) + * [`RASPHSettings.GetViscousForceMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceMaximumNumberOfIterations) + * [`RASPHSettings.GetViscousForceRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceRelativeErrorTolerance) + * [`RASPHSettings.GetViscousForceUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceUnderRelaxationFactor) * [`RASPHSettings.GetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.GetXsphFactor) * [`RASPHSettings.HasGridFunction()`](RASPHSettings.md#generated.RASPHSettings.HasGridFunction) * [`RASPHSettings.IsCellActive()`](RASPHSettings.md#generated.RASPHSettings.IsCellActive) * [`RASPHSettings.IsEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsEulerianSolutionEnabled) + * [`RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled) * [`RASPHSettings.IsShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) * [`RASPHSettings.IsShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) * [`RASPHSettings.IterCellVertices()`](RASPHSettings.md#generated.RASPHSettings.IterCellVertices) @@ -3218,7 +3441,6 @@ * [`RASPHSettings.RemoveCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.RemoveCustomProperty) * [`RASPHSettings.RemoveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.RemoveOutputVariable) * [`RASPHSettings.RemoveProcess()`](RASPHSettings.md#generated.RASPHSettings.RemoveProcess) - * [`RASPHSettings.SetBackgroundPressure()`](RASPHSettings.md#generated.RASPHSettings.SetBackgroundPressure) * [`RASPHSettings.SetCS()`](RASPHSettings.md#generated.RASPHSettings.SetCS) * [`RASPHSettings.SetClearyFactor()`](RASPHSettings.md#generated.RASPHSettings.SetClearyFactor) * [`RASPHSettings.SetCurrentTimeStep()`](RASPHSettings.md#generated.RASPHSettings.SetCurrentTimeStep) @@ -3228,9 +3450,11 @@ * [`RASPHSettings.SetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.SetDissFactor) * [`RASPHSettings.SetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorNorm) * [`RASPHSettings.SetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorTang) + * [`RASPHSettings.SetEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEnabled) * [`RASPHSettings.SetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEulerianSolutionEnabled) * [`RASPHSettings.SetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.SetFluidMaterial) * [`RASPHSettings.SetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit) + * [`RASPHSettings.SetIncompressibilityRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetIncompressibilityRelaxationFactor) * [`RASPHSettings.SetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetKernelDistFactor) * [`RASPHSettings.SetKernelType()`](RASPHSettings.md#generated.RASPHSettings.SetKernelType) * [`RASPHSettings.SetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.SetLimitTurbulentViscosity) @@ -3243,6 +3467,7 @@ * [`RASPHSettings.SetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.SetPosCorrectionType) * [`RASPHSettings.SetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.SetPressureDeg) * [`RASPHSettings.SetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetPressureUnderRelaxationFactor) + * [`RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled) * [`RASPHSettings.SetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) * [`RASPHSettings.SetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) * [`RASPHSettings.SetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.SetShiftingFactor) @@ -3266,6 +3491,10 @@ * [`RASPHSettings.SetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.SetUpdateCoupledDensity) * [`RASPHSettings.SetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.SetUseParticlesNeighborsList) * [`RASPHSettings.SetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.SetViscosityType) + * [`RASPHSettings.SetViscousForceIntegration()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceIntegration) + * [`RASPHSettings.SetViscousForceMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceMaximumNumberOfIterations) + * [`RASPHSettings.SetViscousForceRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceRelativeErrorTolerance) + * [`RASPHSettings.SetViscousForceUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceUnderRelaxationFactor) * [`RASPHSettings.SetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.SetXsphFactor) * [RASimulatorRun](RASimulatorRun.md) * [`RASimulatorRun`](RASimulatorRun.md#generated.RASimulatorRun) @@ -3314,7 +3543,6 @@ * [`RASimulatorRun.GetCellNumberOfVertices()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellNumberOfVertices) * [`RASimulatorRun.GetCellPointsAsFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellPointsAsFunction) * [`RASimulatorRun.GetCellVolumeAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellVolumeAsArray) - * [`RASimulatorRun.GetCollectForcesForFemAnalysis()`](RASimulatorRun.md#generated.RASimulatorRun.GetCollectForcesForFemAnalysis) * [`RASimulatorRun.GetContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.GetContactNeighboringDistanceBetweenParticles) * [`RASimulatorRun.GetContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.GetContactNeighboringDistanceBetweenParticlesAndTriangles) * [`RASimulatorRun.GetCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurve) @@ -3324,9 +3552,12 @@ * [`RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries) * [`RASimulatorRun.GetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetDragLimiterFactor) * [`RASimulatorRun.GetElementCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetElementCurve) + * [`RASimulatorRun.GetFacePositions()`](RASimulatorRun.md#generated.RASimulatorRun.GetFacePositions) + * [`RASimulatorRun.GetFaceVertices()`](RASimulatorRun.md#generated.RASimulatorRun.GetFaceVertices) * [`RASimulatorRun.GetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetFixedTimestep) * [`RASimulatorRun.GetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.GetFluentOutputsMultiplier) * [`RASimulatorRun.GetGeometryQuantity()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryQuantity) + * [`RASimulatorRun.GetGeometryTransform()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryTransform) * [`RASimulatorRun.GetGeometryUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryUnit) * [`RASimulatorRun.GetGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunction) * [`RASimulatorRun.GetGridFunctionNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunctionNames) @@ -3340,6 +3571,12 @@ * [`RASimulatorRun.GetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertiesData) * [`RASimulatorRun.GetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertyEnabled) * [`RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.GetMpiHeterogeneous()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiHeterogeneous) + * [`RASimulatorRun.GetMpiHostfile()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiHostfile) + * [`RASimulatorRun.GetMpiHosts()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiHosts) + * [`RASimulatorRun.GetMpiNumberOfProcesses()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiNumberOfProcesses) + * [`RASimulatorRun.GetMpiNumberOfThreads()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiNumberOfThreads) + * [`RASimulatorRun.GetMpiWithinScheduler()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiWithinScheduler) * [`RASimulatorRun.GetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.GetMultiGpuSlicingDirection) * [`RASimulatorRun.GetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.GetNegateInitialOverlaps) * [`RASimulatorRun.GetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetNeighborSearchModel) @@ -3353,15 +3590,13 @@ * [`RASimulatorRun.GetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverRelaxationCoefficient) * [`RASimulatorRun.GetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverlapParticlesDelay) * [`RASimulatorRun.GetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.GetParticleSizeLimitForReordering) + * [`RASimulatorRun.GetProcessingUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetProcessingUnit) * [`RASimulatorRun.GetRefineConcaveSearch()`](RASimulatorRun.md#generated.RASimulatorRun.GetRefineConcaveSearch) * [`RASimulatorRun.GetReleaseParticlesWithoutOverlapCheck()`](RASimulatorRun.md#generated.RASimulatorRun.GetReleaseParticlesWithoutOverlapCheck) * [`RASimulatorRun.GetResetOnlyPhysicalContactsData()`](RASimulatorRun.md#generated.RASimulatorRun.GetResetOnlyPhysicalContactsData) * [`RASimulatorRun.GetResumeDataFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetResumeDataFrequency) * [`RASimulatorRun.GetSimulationDuration()`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationDuration) - * [`RASimulatorRun.GetSimulationOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationOutputFrequency) - * [`RASimulatorRun.GetSimulationTarget()`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationTarget) * [`RASimulatorRun.GetSolverCurvesFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetSolverCurvesFrequency) - * [`RASimulatorRun.GetSolverCurvesOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetSolverCurvesOutputFrequency) * [`RASimulatorRun.GetSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetSortingDistanceFactor) * [`RASimulatorRun.GetSpecialReorderingForWidePsd()`](RASimulatorRun.md#generated.RASimulatorRun.GetSpecialReorderingForWidePsd) * [`RASimulatorRun.GetStandardOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetStandardOutputPropertiesData) @@ -3386,16 +3621,15 @@ * [`RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) * [`RASimulatorRun.GetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDragLimiterFactor) * [`RASimulatorRun.GetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseFixedTimestep) + * [`RASimulatorRun.GetUseMpi()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseMpi) * [`RASimulatorRun.GetUseNonRoundTorqueCorrection()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseNonRoundTorqueCorrection) * [`RASimulatorRun.GetUseSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseSortingDistanceFactor) * [`RASimulatorRun.GetValidDeformableMassMatrixTypeValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidDeformableMassMatrixTypeValues) * [`RASimulatorRun.GetValidMultiGpuSlicingDirectionValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidMultiGpuSlicingDirectionValues) * [`RASimulatorRun.GetValidNeighborSearchModelValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidNeighborSearchModelValues) - * [`RASimulatorRun.GetValidSimulationTargetValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidSimulationTargetValues) + * [`RASimulatorRun.GetValidProcessingUnitValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidProcessingUnitValues) * [`RASimulatorRun.GetValidTimestepModelValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidTimestepModelValues) - * [`RASimulatorRun.GetWearEnergySpectraBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearEnergySpectraBreakageDelayAfterRelease) - * [`RASimulatorRun.GetWearEnergySpectraBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearEnergySpectraBreakageStart) - * [`RASimulatorRun.GetWearGeometryUpdateFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateFrequency) + * [`RASimulatorRun.GetVertices()`](RASimulatorRun.md#generated.RASimulatorRun.GetVertices) * [`RASimulatorRun.GetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateInterval) * [`RASimulatorRun.GetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearStart) * [`RASimulatorRun.HasFEMForcesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.HasFEMForcesEnabled) @@ -3420,7 +3654,6 @@ * [`RASimulatorRun.SetBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.SetBreakageDelayAfterRelease) * [`RASimulatorRun.SetBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetBreakageOverlapFactor) * [`RASimulatorRun.SetBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.SetBreakageStart) - * [`RASimulatorRun.SetCollectForcesForFemAnalysis()`](RASimulatorRun.md#generated.RASimulatorRun.SetCollectForcesForFemAnalysis) * [`RASimulatorRun.SetContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.SetContactNeighboringDistanceBetweenParticles) * [`RASimulatorRun.SetContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.SetContactNeighboringDistanceBetweenParticlesAndTriangles) * [`RASimulatorRun.SetCurrentTimeStep()`](RASimulatorRun.md#generated.RASimulatorRun.SetCurrentTimeStep) @@ -3438,6 +3671,12 @@ * [`RASimulatorRun.SetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertiesData) * [`RASimulatorRun.SetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertyEnabled) * [`RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.SetMpiHeterogeneous()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiHeterogeneous) + * [`RASimulatorRun.SetMpiHostfile()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiHostfile) + * [`RASimulatorRun.SetMpiHosts()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiHosts) + * [`RASimulatorRun.SetMpiNumberOfProcesses()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiNumberOfProcesses) + * [`RASimulatorRun.SetMpiNumberOfThreads()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiNumberOfThreads) + * [`RASimulatorRun.SetMpiWithinScheduler()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiWithinScheduler) * [`RASimulatorRun.SetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.SetMultiGpuSlicingDirection) * [`RASimulatorRun.SetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.SetNegateInitialOverlaps) * [`RASimulatorRun.SetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetNeighborSearchModel) @@ -3447,15 +3686,13 @@ * [`RASimulatorRun.SetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverRelaxationCoefficient) * [`RASimulatorRun.SetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverlapParticlesDelay) * [`RASimulatorRun.SetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.SetParticleSizeLimitForReordering) + * [`RASimulatorRun.SetProcessingUnit()`](RASimulatorRun.md#generated.RASimulatorRun.SetProcessingUnit) * [`RASimulatorRun.SetRefineConcaveSearch()`](RASimulatorRun.md#generated.RASimulatorRun.SetRefineConcaveSearch) * [`RASimulatorRun.SetReleaseParticlesWithoutOverlapCheck()`](RASimulatorRun.md#generated.RASimulatorRun.SetReleaseParticlesWithoutOverlapCheck) * [`RASimulatorRun.SetResetOnlyPhysicalContactsData()`](RASimulatorRun.md#generated.RASimulatorRun.SetResetOnlyPhysicalContactsData) * [`RASimulatorRun.SetResumeDataFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetResumeDataFrequency) * [`RASimulatorRun.SetSimulationDuration()`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationDuration) - * [`RASimulatorRun.SetSimulationOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationOutputFrequency) - * [`RASimulatorRun.SetSimulationTarget()`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationTarget) * [`RASimulatorRun.SetSolverCurvesFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetSolverCurvesFrequency) - * [`RASimulatorRun.SetSolverCurvesOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetSolverCurvesOutputFrequency) * [`RASimulatorRun.SetSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetSortingDistanceFactor) * [`RASimulatorRun.SetSpecialReorderingForWidePsd()`](RASimulatorRun.md#generated.RASimulatorRun.SetSpecialReorderingForWidePsd) * [`RASimulatorRun.SetStandardOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetStandardOutputPropertiesData) @@ -3477,11 +3714,9 @@ * [`RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) * [`RASimulatorRun.SetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDragLimiterFactor) * [`RASimulatorRun.SetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseFixedTimestep) + * [`RASimulatorRun.SetUseMpi()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseMpi) * [`RASimulatorRun.SetUseNonRoundTorqueCorrection()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseNonRoundTorqueCorrection) * [`RASimulatorRun.SetUseSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseSortingDistanceFactor) - * [`RASimulatorRun.SetWearEnergySpectraBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearEnergySpectraBreakageDelayAfterRelease) - * [`RASimulatorRun.SetWearEnergySpectraBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearEnergySpectraBreakageStart) - * [`RASimulatorRun.SetWearGeometryUpdateFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearGeometryUpdateFrequency) * [`RASimulatorRun.SetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearGeometryUpdateInterval) * [`RASimulatorRun.SetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearStart) * [RASizeDistribution](RASizeDistribution.md) @@ -3573,7 +3808,10 @@ * [`RAStreamlinesUserProcess.GetCurveNamesAssociation()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation) * [`RAStreamlinesUserProcess.GetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetDirection) * [`RAStreamlinesUserProcess.GetElementCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetElementCurve) + * [`RAStreamlinesUserProcess.GetFacePositions()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetFacePositions) + * [`RAStreamlinesUserProcess.GetFaceVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetFaceVertices) * [`RAStreamlinesUserProcess.GetGeometryQuantity()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryQuantity) + * [`RAStreamlinesUserProcess.GetGeometryTransform()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryTransform) * [`RAStreamlinesUserProcess.GetGeometryUnit()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryUnit) * [`RAStreamlinesUserProcess.GetGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunction) * [`RAStreamlinesUserProcess.GetGridFunctionNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunctionNames) @@ -3591,6 +3829,7 @@ * [`RAStreamlinesUserProcess.GetTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStep) * [`RAStreamlinesUserProcess.GetTopologyShape()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTopologyShape) * [`RAStreamlinesUserProcess.GetValidDirectionValues()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetValidDirectionValues) + * [`RAStreamlinesUserProcess.GetVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetVertices) * [`RAStreamlinesUserProcess.HasGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.HasGridFunction) * [`RAStreamlinesUserProcess.IsCellActive()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IsCellActive) * [`RAStreamlinesUserProcess.IterCellVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCellVertices) @@ -3610,15 +3849,11 @@ * [RAStudy](RAStudy.md) * [`RAStudy`](RAStudy.md#generated.RAStudy) * [`RAStudy.CanResumeSimulation()`](RAStudy.md#generated.RAStudy.CanResumeSimulation) - * [`RAStudy.CreateContinuousInjection()`](RAStudy.md#generated.RAStudy.CreateContinuousInjection) * [`RAStudy.CreateFeedConveyor()`](RAStudy.md#generated.RAStudy.CreateFeedConveyor) - * [`RAStudy.CreateInlet()`](RAStudy.md#generated.RAStudy.CreateInlet) - * [`RAStudy.CreateMaterialAndRelatedInteractions()`](RAStudy.md#generated.RAStudy.CreateMaterialAndRelatedInteractions) * [`RAStudy.CreateOutlet()`](RAStudy.md#generated.RAStudy.CreateOutlet) * [`RAStudy.CreateParticle()`](RAStudy.md#generated.RAStudy.CreateParticle) * [`RAStudy.CreateParticleInlet()`](RAStudy.md#generated.RAStudy.CreateParticleInlet) * [`RAStudy.CreateReceivingConveyor()`](RAStudy.md#generated.RAStudy.CreateReceivingConveyor) - * [`RAStudy.CreateVolumeFill()`](RAStudy.md#generated.RAStudy.CreateVolumeFill) * [`RAStudy.CreateVolumetricInlet()`](RAStudy.md#generated.RAStudy.CreateVolumetricInlet) * [`RAStudy.DeleteResults()`](RAStudy.md#generated.RAStudy.DeleteResults) * [`RAStudy.ExtendSimulation()`](RAStudy.md#generated.RAStudy.ExtendSimulation) @@ -3662,7 +3897,6 @@ * [`RAStudy.ImportWall()`](RAStudy.md#generated.RAStudy.ImportWall) * [`RAStudy.IsSimulating()`](RAStudy.md#generated.RAStudy.IsSimulating) * [`RAStudy.RefreshResults()`](RAStudy.md#generated.RAStudy.RefreshResults) - * [`RAStudy.RemoveMaterialAndRelatedInteractions()`](RAStudy.md#generated.RAStudy.RemoveMaterialAndRelatedInteractions) * [`RAStudy.RemoveSurface()`](RAStudy.md#generated.RAStudy.RemoveSurface) * [`RAStudy.RemoveWall()`](RAStudy.md#generated.RAStudy.RemoveWall) * [`RAStudy.ReplaceWallTriangles()`](RAStudy.md#generated.RAStudy.ReplaceWallTriangles) @@ -3703,12 +3937,16 @@ * [`RASurface.GetCurveNames()`](RASurface.md#generated.RASurface.GetCurveNames) * [`RASurface.GetCurveNamesAssociation()`](RASurface.md#generated.RASurface.GetCurveNamesAssociation) * [`RASurface.GetElementCurve()`](RASurface.md#generated.RASurface.GetElementCurve) + * [`RASurface.GetFacePositions()`](RASurface.md#generated.RASurface.GetFacePositions) + * [`RASurface.GetFaceVertices()`](RASurface.md#generated.RASurface.GetFaceVertices) * [`RASurface.GetGeometryQuantity()`](RASurface.md#generated.RASurface.GetGeometryQuantity) + * [`RASurface.GetGeometryTransform()`](RASurface.md#generated.RASurface.GetGeometryTransform) * [`RASurface.GetGeometryUnit()`](RASurface.md#generated.RASurface.GetGeometryUnit) * [`RASurface.GetGridFunction()`](RASurface.md#generated.RASurface.GetGridFunction) * [`RASurface.GetGridFunctionNames()`](RASurface.md#generated.RASurface.GetGridFunctionNames) * [`RASurface.GetInvertNormal()`](RASurface.md#generated.RASurface.GetInvertNormal) * [`RASurface.GetMeshColoring()`](RASurface.md#generated.RASurface.GetMeshColoring) + * [`RASurface.GetMotionFrame()`](RASurface.md#generated.RASurface.GetMotionFrame) * [`RASurface.GetNumberOfCells()`](RASurface.md#generated.RASurface.GetNumberOfCells) * [`RASurface.GetNumberOfNodes()`](RASurface.md#generated.RASurface.GetNumberOfNodes) * [`RASurface.GetNumpyCurve()`](RASurface.md#generated.RASurface.GetNumpyCurve) @@ -3723,6 +3961,7 @@ * [`RASurface.GetTimeStep()`](RASurface.md#generated.RASurface.GetTimeStep) * [`RASurface.GetTopologyShape()`](RASurface.md#generated.RASurface.GetTopologyShape) * [`RASurface.GetTranslation()`](RASurface.md#generated.RASurface.GetTranslation) + * [`RASurface.GetVertices()`](RASurface.md#generated.RASurface.GetVertices) * [`RASurface.HasGridFunction()`](RASurface.md#generated.RASurface.HasGridFunction) * [`RASurface.HasMotionFrame()`](RASurface.md#generated.RASurface.HasMotionFrame) * [`RASurface.IsCellActive()`](RASurface.md#generated.RASurface.IsCellActive) @@ -3735,6 +3974,7 @@ * [`RASurface.RemoveProcess()`](RASurface.md#generated.RASurface.RemoveProcess) * [`RASurface.SetCurrentTimeStep()`](RASurface.md#generated.RASurface.SetCurrentTimeStep) * [`RASurface.SetInvertNormal()`](RASurface.md#generated.RASurface.SetInvertNormal) + * [`RASurface.SetMotionFrame()`](RASurface.md#generated.RASurface.SetMotionFrame) * [`RASurface.SetOrientation()`](RASurface.md#generated.RASurface.SetOrientation) * [`RASurface.SetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.SetOrientationFromAngleAndVector) * [`RASurface.SetOrientationFromAngles()`](RASurface.md#generated.RASurface.SetOrientationFromAngles) @@ -3769,7 +4009,10 @@ * [`RASurfaceUserProcess.GetCurveNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNames) * [`RASurfaceUserProcess.GetCurveNamesAssociation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNamesAssociation) * [`RASurfaceUserProcess.GetElementCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetElementCurve) + * [`RASurfaceUserProcess.GetFacePositions()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetFacePositions) + * [`RASurfaceUserProcess.GetFaceVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetFaceVertices) * [`RASurfaceUserProcess.GetGeometryQuantity()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryQuantity) + * [`RASurfaceUserProcess.GetGeometryTransform()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryTransform) * [`RASurfaceUserProcess.GetGeometryUnit()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryUnit) * [`RASurfaceUserProcess.GetGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunction) * [`RASurfaceUserProcess.GetGridFunctionNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunctionNames) @@ -3789,6 +4032,7 @@ * [`RASurfaceUserProcess.GetTimeStatistics()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStatistics) * [`RASurfaceUserProcess.GetTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStep) * [`RASurfaceUserProcess.GetTopologyShape()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTopologyShape) + * [`RASurfaceUserProcess.GetVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetVertices) * [`RASurfaceUserProcess.HasGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.HasGridFunction) * [`RASurfaceUserProcess.IsCellActive()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IsCellActive) * [`RASurfaceUserProcess.IterCellVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCellVertices) @@ -3828,6 +4072,7 @@ * [`RASystemCouplingWall.GetActivesArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetActivesArray) * [`RASystemCouplingWall.GetAvailableMaterials()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetAvailableMaterials) * [`RASystemCouplingWall.GetBoundingBox()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetBoundingBox) + * [`RASystemCouplingWall.GetCapillaryFrictionCoefficient()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCapillaryFrictionCoefficient) * [`RASystemCouplingWall.GetCellAreaAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellAreaAsArray) * [`RASystemCouplingWall.GetCellCenterAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellCenterAsArray) * [`RASystemCouplingWall.GetCellDzAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellDzAsArray) @@ -3840,7 +4085,10 @@ * [`RASystemCouplingWall.GetCurveNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNames) * [`RASystemCouplingWall.GetCurveNamesAssociation()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNamesAssociation) * [`RASystemCouplingWall.GetElementCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetElementCurve) + * [`RASystemCouplingWall.GetFacePositions()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetFacePositions) + * [`RASystemCouplingWall.GetFaceVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetFaceVertices) * [`RASystemCouplingWall.GetGeometryQuantity()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryQuantity) + * [`RASystemCouplingWall.GetGeometryTransform()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryTransform) * [`RASystemCouplingWall.GetGeometryUnit()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryUnit) * [`RASystemCouplingWall.GetGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunction) * [`RASystemCouplingWall.GetGridFunctionNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunctionNames) @@ -3861,6 +4109,7 @@ * [`RASystemCouplingWall.GetTopologyShape()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTopologyShape) * [`RASystemCouplingWall.GetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTriangleSize) * [`RASystemCouplingWall.GetValidSphBoundaryTypeValues()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues) + * [`RASystemCouplingWall.GetVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetVertices) * [`RASystemCouplingWall.HasGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasGridFunction) * [`RASystemCouplingWall.HasMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasMotionFrame) * [`RASystemCouplingWall.IsCellActive()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsCellActive) @@ -3873,6 +4122,7 @@ * [`RASystemCouplingWall.RemoveCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomProperty) * [`RASystemCouplingWall.RemoveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveOutputVariable) * [`RASystemCouplingWall.RemoveProcess()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveProcess) + * [`RASystemCouplingWall.SetCapillaryFrictionCoefficient()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCapillaryFrictionCoefficient) * [`RASystemCouplingWall.SetCurrentTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCurrentTimeStep) * [`RASystemCouplingWall.SetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMaterial) * [`RASystemCouplingWall.SetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMotionFrame) @@ -3905,6 +4155,39 @@ * [`RAThreeRollsBeltProfile.SetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetMaterial) * [`RAThreeRollsBeltProfile.SetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetTroughingAngle) * [`RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths) + * [RATimePlotWindow](RATimePlotWindow.md) + * [`RATimePlotWindow`](RATimePlotWindow.md#generated.RATimePlotWindow) + * [`RATimePlotWindow.ClearCurves()`](RATimePlotWindow.md#generated.RATimePlotWindow.ClearCurves) + * [`RATimePlotWindow.CloseWindow()`](RATimePlotWindow.md#generated.RATimePlotWindow.CloseWindow) + * [`RATimePlotWindow.CreateMark()`](RATimePlotWindow.md#generated.RATimePlotWindow.CreateMark) + * [`RATimePlotWindow.CreateTimeMark()`](RATimePlotWindow.md#generated.RATimePlotWindow.CreateTimeMark) + * [`RATimePlotWindow.ExportCurves()`](RATimePlotWindow.md#generated.RATimePlotWindow.ExportCurves) + * [`RATimePlotWindow.GetAxisLimits()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetAxisLimits) + * [`RATimePlotWindow.GetAxisUnit()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetAxisUnit) + * [`RATimePlotWindow.GetCurvesDescription()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetCurvesDescription) + * [`RATimePlotWindow.GetTable()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetTable) + * [`RATimePlotWindow.GetTimeStep()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetTimeStep) + * [`RATimePlotWindow.GetTitle()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetTitle) + * [`RATimePlotWindow.InvalidateWindow()`](RATimePlotWindow.md#generated.RATimePlotWindow.InvalidateWindow) + * [`RATimePlotWindow.Resize()`](RATimePlotWindow.md#generated.RATimePlotWindow.Resize) + * [`RATimePlotWindow.SetAxisByProperty()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisByProperty) + * [`RATimePlotWindow.SetAxisByQuantity()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisByQuantity) + * [`RATimePlotWindow.SetAxisLimits()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisLimits) + * [`RATimePlotWindow.SetAxisUnit()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisUnit) + * [`RATimePlotWindow.SetBottomAxisUnit()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetBottomAxisUnit) + * [`RATimePlotWindow.SetColoringStrategyByElement()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetColoringStrategyByElement) + * [`RATimePlotWindow.SetColoringStrategyByProperty()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetColoringStrategyByProperty) + * [`RATimePlotWindow.SetColoringStrategyByStudy()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetColoringStrategyByStudy) + * [`RATimePlotWindow.SetCurrentTimeStep()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetCurrentTimeStep) + * [`RATimePlotWindow.SetSelectedWindow()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetSelectedWindow) + * [`RATimePlotWindow.SetStickEnabled()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetStickEnabled) + * [`RATimePlotWindow.ShowCurve()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowCurve) + * [`RATimePlotWindow.ShowGridFunctionStatisticsCurve()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowGridFunctionStatisticsCurve) + * [`RATimePlotWindow.ShowMaximized()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowMaximized) + * [`RATimePlotWindow.ShowMinimized()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowMinimized) + * [`RATimePlotWindow.ShowNormal()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowNormal) + * [`RATimePlotWindow.Snapshot()`](RATimePlotWindow.md#generated.RATimePlotWindow.Snapshot) + * [`RATimePlotWindow.app`](RATimePlotWindow.md#generated.RATimePlotWindow.app) * [RATimeRangeFilter](RATimeRangeFilter.md) * [`RATimeRangeFilter`](RATimeRangeFilter.md#generated.RATimeRangeFilter) * [`RATimeRangeFilter.GetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetDomainRange) @@ -3947,7 +4230,10 @@ * [`RATrajectoryProcess.GetCurveNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNames) * [`RATrajectoryProcess.GetCurveNamesAssociation()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNamesAssociation) * [`RATrajectoryProcess.GetElementCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetElementCurve) + * [`RATrajectoryProcess.GetFacePositions()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetFacePositions) + * [`RATrajectoryProcess.GetFaceVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetFaceVertices) * [`RATrajectoryProcess.GetGeometryQuantity()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryQuantity) + * [`RATrajectoryProcess.GetGeometryTransform()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryTransform) * [`RATrajectoryProcess.GetGeometryUnit()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryUnit) * [`RATrajectoryProcess.GetGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunction) * [`RATrajectoryProcess.GetGridFunctionNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunctionNames) @@ -3956,16 +4242,15 @@ * [`RATrajectoryProcess.GetNumberOfIntervals()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfIntervals) * [`RATrajectoryProcess.GetNumberOfNodes()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfNodes) * [`RATrajectoryProcess.GetNumberOfParticles()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfParticles) - * [`RATrajectoryProcess.GetNumberOfTimeSteps()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfTimeSteps) * [`RATrajectoryProcess.GetNumpyCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumpyCurve) * [`RATrajectoryProcess.GetOutputVariableValue()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetOutputVariableValue) * [`RATrajectoryProcess.GetParticleStride()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetParticleStride) * [`RATrajectoryProcess.GetStartingTime()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetStartingTime) - * [`RATrajectoryProcess.GetStartingTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetStartingTimeStep) * [`RATrajectoryProcess.GetTimeSet()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTimeSet) * [`RATrajectoryProcess.GetTimeStatistics()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTimeStatistics) * [`RATrajectoryProcess.GetTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTimeStep) * [`RATrajectoryProcess.GetTopologyShape()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTopologyShape) + * [`RATrajectoryProcess.GetVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetVertices) * [`RATrajectoryProcess.HasGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.HasGridFunction) * [`RATrajectoryProcess.IsCellActive()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IsCellActive) * [`RATrajectoryProcess.IterCellVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCellVertices) @@ -3978,10 +4263,8 @@ * [`RATrajectoryProcess.RemoveProcess()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveProcess) * [`RATrajectoryProcess.SetCurrentTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetCurrentTimeStep) * [`RATrajectoryProcess.SetNumberOfIntervals()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetNumberOfIntervals) - * [`RATrajectoryProcess.SetNumberOfTimeSteps()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetNumberOfTimeSteps) * [`RATrajectoryProcess.SetParticleStride()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetParticleStride) * [`RATrajectoryProcess.SetStartingTime()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetStartingTime) - * [`RATrajectoryProcess.SetStartingTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetStartingTimeStep) * [`RATrajectoryProcess.UpdateParticlesSelection()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.UpdateParticlesSelection) * [RATranslation](RATranslation.md) * [`RATranslation`](RATranslation.md#generated.RATranslation) @@ -4051,8 +4334,11 @@ * [`RAVibration.SetInitialPhase()`](RAVibration.md#generated.RAVibration.SetInitialPhase) * [RAVolumetricInlet](RAVolumetricInlet.md) * [`RAVolumetricInlet`](RAVolumetricInlet.md#generated.RAVolumetricInlet) + * [`RAVolumetricInlet.AddParticle()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.AddParticle) * [`RAVolumetricInlet.DisablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisablePeriodic) + * [`RAVolumetricInlet.DisableUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisableUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.EnablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnablePeriodic) + * [`RAVolumetricInlet.EnableUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnableUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.GetAvailableGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetAvailableGeometries) * [`RAVolumetricInlet.GetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxCenter) * [`RAVolumetricInlet.GetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxDimensions) @@ -4071,8 +4357,11 @@ * [`RAVolumetricInlet.GetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphMass) * [`RAVolumetricInlet.GetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphTemperature) * [`RAVolumetricInlet.GetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetStopTime) + * [`RAVolumetricInlet.GetUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.GetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseGeometriesToCompute) * [`RAVolumetricInlet.IsPeriodicEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled) + * [`RAVolumetricInlet.IsUseBoxCenterAsSeedPointEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsUseBoxCenterAsSeedPointEnabled) + * [`RAVolumetricInlet.RemoveParticle()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.RemoveParticle) * [`RAVolumetricInlet.SetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxCenter) * [`RAVolumetricInlet.SetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxDimensions) * [`RAVolumetricInlet.SetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGapScaleFactor) @@ -4089,6 +4378,7 @@ * [`RAVolumetricInlet.SetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphMass) * [`RAVolumetricInlet.SetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphTemperature) * [`RAVolumetricInlet.SetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetStopTime) + * [`RAVolumetricInlet.SetUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.SetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseGeometriesToCompute) * [RAVolumetricInletProperties](RAVolumetricInletProperties.md) * [`RAVolumetricInletProperties`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties) @@ -4125,6 +4415,7 @@ * [`RAWall.GetAvailableMaterials()`](RAWall.md#generated.RAWall.GetAvailableMaterials) * [`RAWall.GetBoundaryMass()`](RAWall.md#generated.RAWall.GetBoundaryMass) * [`RAWall.GetBoundingBox()`](RAWall.md#generated.RAWall.GetBoundingBox) + * [`RAWall.GetCapillaryFrictionCoefficient()`](RAWall.md#generated.RAWall.GetCapillaryFrictionCoefficient) * [`RAWall.GetCellAreaAsArray()`](RAWall.md#generated.RAWall.GetCellAreaAsArray) * [`RAWall.GetCellCenterAsArray()`](RAWall.md#generated.RAWall.GetCellCenterAsArray) * [`RAWall.GetCellDzAsArray()`](RAWall.md#generated.RAWall.GetCellDzAsArray) @@ -4139,12 +4430,14 @@ * [`RAWall.GetDisableTime()`](RAWall.md#generated.RAWall.GetDisableTime) * [`RAWall.GetElementCurve()`](RAWall.md#generated.RAWall.GetElementCurve) * [`RAWall.GetEnableTime()`](RAWall.md#generated.RAWall.GetEnableTime) + * [`RAWall.GetFacePositions()`](RAWall.md#generated.RAWall.GetFacePositions) + * [`RAWall.GetFaceVertices()`](RAWall.md#generated.RAWall.GetFaceVertices) * [`RAWall.GetGeometryQuantity()`](RAWall.md#generated.RAWall.GetGeometryQuantity) + * [`RAWall.GetGeometryTransform()`](RAWall.md#generated.RAWall.GetGeometryTransform) * [`RAWall.GetGeometryUnit()`](RAWall.md#generated.RAWall.GetGeometryUnit) * [`RAWall.GetGravityCenter()`](RAWall.md#generated.RAWall.GetGravityCenter) * [`RAWall.GetGridFunction()`](RAWall.md#generated.RAWall.GetGridFunction) * [`RAWall.GetGridFunctionNames()`](RAWall.md#generated.RAWall.GetGridFunctionNames) - * [`RAWall.GetHorizontalOffset()`](RAWall.md#generated.RAWall.GetHorizontalOffset) * [`RAWall.GetMaterial()`](RAWall.md#generated.RAWall.GetMaterial) * [`RAWall.GetMeshColoring()`](RAWall.md#generated.RAWall.GetMeshColoring) * [`RAWall.GetModuleProperties()`](RAWall.md#generated.RAWall.GetModuleProperties) @@ -4152,6 +4445,7 @@ * [`RAWall.GetMomentXDirection()`](RAWall.md#generated.RAWall.GetMomentXDirection) * [`RAWall.GetMomentYDirection()`](RAWall.md#generated.RAWall.GetMomentYDirection) * [`RAWall.GetMomentZDirection()`](RAWall.md#generated.RAWall.GetMomentZDirection) + * [`RAWall.GetMotionFrame()`](RAWall.md#generated.RAWall.GetMotionFrame) * [`RAWall.GetNumberOfCells()`](RAWall.md#generated.RAWall.GetNumberOfCells) * [`RAWall.GetNumberOfNodes()`](RAWall.md#generated.RAWall.GetNumberOfNodes) * [`RAWall.GetNumberOfReplications()`](RAWall.md#generated.RAWall.GetNumberOfReplications) @@ -4160,7 +4454,6 @@ * [`RAWall.GetOrientationFromAngleAndVector()`](RAWall.md#generated.RAWall.GetOrientationFromAngleAndVector) * [`RAWall.GetOrientationFromAngles()`](RAWall.md#generated.RAWall.GetOrientationFromAngles) * [`RAWall.GetOrientationFromBasisVector()`](RAWall.md#generated.RAWall.GetOrientationFromBasisVector) - * [`RAWall.GetOutOfPlaneOffset()`](RAWall.md#generated.RAWall.GetOutOfPlaneOffset) * [`RAWall.GetOutputVariableValue()`](RAWall.md#generated.RAWall.GetOutputVariableValue) * [`RAWall.GetPeriodicReplication()`](RAWall.md#generated.RAWall.GetPeriodicReplication) * [`RAWall.GetPivotPoint()`](RAWall.md#generated.RAWall.GetPivotPoint) @@ -4181,7 +4474,7 @@ * [`RAWall.GetValidSphBoundaryTypeValues()`](RAWall.md#generated.RAWall.GetValidSphBoundaryTypeValues) * [`RAWall.GetValidThermalBoundaryConditionTypeValues()`](RAWall.md#generated.RAWall.GetValidThermalBoundaryConditionTypeValues) * [`RAWall.GetValidWearModelValues()`](RAWall.md#generated.RAWall.GetValidWearModelValues) - * [`RAWall.GetVerticalOffset()`](RAWall.md#generated.RAWall.GetVerticalOffset) + * [`RAWall.GetVertices()`](RAWall.md#generated.RAWall.GetVertices) * [`RAWall.GetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.GetVolumeShearWorkRatio) * [`RAWall.GetWearModel()`](RAWall.md#generated.RAWall.GetWearModel) * [`RAWall.HasGridFunction()`](RAWall.md#generated.RAWall.HasGridFunction) @@ -4197,22 +4490,22 @@ * [`RAWall.RemoveOutputVariable()`](RAWall.md#generated.RAWall.RemoveOutputVariable) * [`RAWall.RemoveProcess()`](RAWall.md#generated.RAWall.RemoveProcess) * [`RAWall.SetBoundaryMass()`](RAWall.md#generated.RAWall.SetBoundaryMass) + * [`RAWall.SetCapillaryFrictionCoefficient()`](RAWall.md#generated.RAWall.SetCapillaryFrictionCoefficient) * [`RAWall.SetCurrentTimeStep()`](RAWall.md#generated.RAWall.SetCurrentTimeStep) * [`RAWall.SetDisableTime()`](RAWall.md#generated.RAWall.SetDisableTime) * [`RAWall.SetEnableTime()`](RAWall.md#generated.RAWall.SetEnableTime) * [`RAWall.SetGravityCenter()`](RAWall.md#generated.RAWall.SetGravityCenter) - * [`RAWall.SetHorizontalOffset()`](RAWall.md#generated.RAWall.SetHorizontalOffset) * [`RAWall.SetMaterial()`](RAWall.md#generated.RAWall.SetMaterial) * [`RAWall.SetModuleProperty()`](RAWall.md#generated.RAWall.SetModuleProperty) * [`RAWall.SetMomentXDirection()`](RAWall.md#generated.RAWall.SetMomentXDirection) * [`RAWall.SetMomentYDirection()`](RAWall.md#generated.RAWall.SetMomentYDirection) * [`RAWall.SetMomentZDirection()`](RAWall.md#generated.RAWall.SetMomentZDirection) + * [`RAWall.SetMotionFrame()`](RAWall.md#generated.RAWall.SetMotionFrame) * [`RAWall.SetNumberOfReplications()`](RAWall.md#generated.RAWall.SetNumberOfReplications) * [`RAWall.SetOrientation()`](RAWall.md#generated.RAWall.SetOrientation) * [`RAWall.SetOrientationFromAngleAndVector()`](RAWall.md#generated.RAWall.SetOrientationFromAngleAndVector) * [`RAWall.SetOrientationFromAngles()`](RAWall.md#generated.RAWall.SetOrientationFromAngles) * [`RAWall.SetOrientationFromBasisVector()`](RAWall.md#generated.RAWall.SetOrientationFromBasisVector) - * [`RAWall.SetOutOfPlaneOffset()`](RAWall.md#generated.RAWall.SetOutOfPlaneOffset) * [`RAWall.SetPeriodicReplication()`](RAWall.md#generated.RAWall.SetPeriodicReplication) * [`RAWall.SetPivotPoint()`](RAWall.md#generated.RAWall.SetPivotPoint) * [`RAWall.SetPrincipalMomentOfInertia()`](RAWall.md#generated.RAWall.SetPrincipalMomentOfInertia) @@ -4224,13 +4517,11 @@ * [`RAWall.SetThermalBoundaryConditionType()`](RAWall.md#generated.RAWall.SetThermalBoundaryConditionType) * [`RAWall.SetTranslation()`](RAWall.md#generated.RAWall.SetTranslation) * [`RAWall.SetTriangleSize()`](RAWall.md#generated.RAWall.SetTriangleSize) - * [`RAWall.SetUseWear()`](RAWall.md#generated.RAWall.SetUseWear) - * [`RAWall.SetVerticalOffset()`](RAWall.md#generated.RAWall.SetVerticalOffset) * [`RAWall.SetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.SetVolumeShearWorkRatio) * [`RAWall.SetWearModel()`](RAWall.md#generated.RAWall.SetWearModel) * [About Grid Functions / Properties](about-grid-functions.md) * [Stress Tensor](about-grid-functions.md#stress-tensor) -* [Release notes for 2025 R2](changelog.md) +* [Release notes for 2026 R1](changelog.md) * [Added](changelog.md#added) * [New Methods](changelog.md#new-methods) * [New Classes](changelog.md#new-classes) diff --git a/2026R1/rocky-prepost-scripting-manual-26-r1/prepost-scripting-reference.md b/2026R1/rocky-prepost-scripting-manual-26-r1/prepost-scripting-reference.md index 0ceaa146c5..8fa167bd34 100644 --- a/2026R1/rocky-prepost-scripting-manual-26-r1/prepost-scripting-reference.md +++ b/2026R1/rocky-prepost-scripting-manual-26-r1/prepost-scripting-reference.md @@ -4,6 +4,45 @@ These are the classes and methods available to the user when executing scripts: +* [RA3DWindow](RA3DWindow.md) + * [`RA3DWindow`](RA3DWindow.md#generated.RA3DWindow) + * [`RA3DWindow.ApplyGridFunctionToAll()`](RA3DWindow.md#generated.RA3DWindow.ApplyGridFunctionToAll) + * [`RA3DWindow.CloseWindow()`](RA3DWindow.md#generated.RA3DWindow.CloseWindow) + * [`RA3DWindow.CreateAnimationKeyFrame()`](RA3DWindow.md#generated.RA3DWindow.CreateAnimationKeyFrame) + * [`RA3DWindow.ExportAnimation()`](RA3DWindow.md#generated.RA3DWindow.ExportAnimation) + * [`RA3DWindow.GetActiveSimulation()`](RA3DWindow.md#generated.RA3DWindow.GetActiveSimulation) + * [`RA3DWindow.GetAnimationKeyFramesCount()`](RA3DWindow.md#generated.RA3DWindow.GetAnimationKeyFramesCount) + * [`RA3DWindow.GetCamera()`](RA3DWindow.md#generated.RA3DWindow.GetCamera) + * [`RA3DWindow.GetSize()`](RA3DWindow.md#generated.RA3DWindow.GetSize) + * [`RA3DWindow.Hide()`](RA3DWindow.md#generated.RA3DWindow.Hide) + * [`RA3DWindow.HideEdges()`](RA3DWindow.md#generated.RA3DWindow.HideEdges) + * [`RA3DWindow.HideNodes()`](RA3DWindow.md#generated.RA3DWindow.HideNodes) + * [`RA3DWindow.RemoveAllAnimationKeyFrames()`](RA3DWindow.md#generated.RA3DWindow.RemoveAllAnimationKeyFrames) + * [`RA3DWindow.Resize()`](RA3DWindow.md#generated.RA3DWindow.Resize) + * [`RA3DWindow.SetActiveSimulation()`](RA3DWindow.md#generated.RA3DWindow.SetActiveSimulation) + * [`RA3DWindow.SetAnimationCameraInterpolation()`](RA3DWindow.md#generated.RA3DWindow.SetAnimationCameraInterpolation) + * [`RA3DWindow.SetAnimationFPS()`](RA3DWindow.md#generated.RA3DWindow.SetAnimationFPS) + * [`RA3DWindow.SetBackgroundColor()`](RA3DWindow.md#generated.RA3DWindow.SetBackgroundColor) + * [`RA3DWindow.SetCameraPreset()`](RA3DWindow.md#generated.RA3DWindow.SetCameraPreset) + * [`RA3DWindow.SetEdgesVisible()`](RA3DWindow.md#generated.RA3DWindow.SetEdgesVisible) + * [`RA3DWindow.SetForegroundColor()`](RA3DWindow.md#generated.RA3DWindow.SetForegroundColor) + * [`RA3DWindow.SetNodesVisible()`](RA3DWindow.md#generated.RA3DWindow.SetNodesVisible) + * [`RA3DWindow.SetSelectedWindow()`](RA3DWindow.md#generated.RA3DWindow.SetSelectedWindow) + * [`RA3DWindow.SetTransparency()`](RA3DWindow.md#generated.RA3DWindow.SetTransparency) + * [`RA3DWindow.SetVisible()`](RA3DWindow.md#generated.RA3DWindow.SetVisible) + * [`RA3DWindow.Show()`](RA3DWindow.md#generated.RA3DWindow.Show) + * [`RA3DWindow.ShowEdges()`](RA3DWindow.md#generated.RA3DWindow.ShowEdges) + * [`RA3DWindow.ShowGeometryGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowGeometryGridFunction) + * [`RA3DWindow.ShowGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowGridFunction) + * [`RA3DWindow.ShowMaximized()`](RA3DWindow.md#generated.RA3DWindow.ShowMaximized) + * [`RA3DWindow.ShowMinimized()`](RA3DWindow.md#generated.RA3DWindow.ShowMinimized) + * [`RA3DWindow.ShowModel()`](RA3DWindow.md#generated.RA3DWindow.ShowModel) + * [`RA3DWindow.ShowNodes()`](RA3DWindow.md#generated.RA3DWindow.ShowNodes) + * [`RA3DWindow.ShowNormal()`](RA3DWindow.md#generated.RA3DWindow.ShowNormal) + * [`RA3DWindow.ShowParticleGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowParticleGridFunction) + * [`RA3DWindow.ShowSphGridFunction()`](RA3DWindow.md#generated.RA3DWindow.ShowSphGridFunction) + * [`RA3DWindow.Snapshot()`](RA3DWindow.md#generated.RA3DWindow.Snapshot) + * [`RA3DWindow.app`](RA3DWindow.md#generated.RA3DWindow.app) * [RAAirFlow](RAAirFlow.md) * [`RAAirFlow`](RAAirFlow.md#generated.RAAirFlow) * [`RAAirFlow.AddCurve()`](RAAirFlow.md#generated.RAAirFlow.AddCurve) @@ -35,7 +74,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAAirFlow.GetCurveNames()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNames) * [`RAAirFlow.GetCurveNamesAssociation()`](RAAirFlow.md#generated.RAAirFlow.GetCurveNamesAssociation) * [`RAAirFlow.GetElementCurve()`](RAAirFlow.md#generated.RAAirFlow.GetElementCurve) + * [`RAAirFlow.GetFacePositions()`](RAAirFlow.md#generated.RAAirFlow.GetFacePositions) + * [`RAAirFlow.GetFaceVertices()`](RAAirFlow.md#generated.RAAirFlow.GetFaceVertices) * [`RAAirFlow.GetGeometryQuantity()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryQuantity) + * [`RAAirFlow.GetGeometryTransform()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryTransform) * [`RAAirFlow.GetGeometryUnit()`](RAAirFlow.md#generated.RAAirFlow.GetGeometryUnit) * [`RAAirFlow.GetGridFunction()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunction) * [`RAAirFlow.GetGridFunctionNames()`](RAAirFlow.md#generated.RAAirFlow.GetGridFunctionNames) @@ -60,6 +102,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAAirFlow.GetTopologyShape()`](RAAirFlow.md#generated.RAAirFlow.GetTopologyShape) * [`RAAirFlow.GetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.GetUseAirflow) * [`RAAirFlow.GetValidBoundaryConditionTypeValues()`](RAAirFlow.md#generated.RAAirFlow.GetValidBoundaryConditionTypeValues) + * [`RAAirFlow.GetVertices()`](RAAirFlow.md#generated.RAAirFlow.GetVertices) * [`RAAirFlow.HasGridFunction()`](RAAirFlow.md#generated.RAAirFlow.HasGridFunction) * [`RAAirFlow.IsCellActive()`](RAAirFlow.md#generated.RAAirFlow.IsCellActive) * [`RAAirFlow.IterCellVertices()`](RAAirFlow.md#generated.RAAirFlow.IterCellVertices) @@ -88,20 +131,13 @@ These are the classes and methods available to the user when executing scripts: * [`RAAirFlow.SetUseAirflow()`](RAAirFlow.md#generated.RAAirFlow.SetUseAirflow) * [RACFDCoupling](RACFDCoupling.md) * [`RACFDCoupling`](RACFDCoupling.md#generated.RACFDCoupling) - * [`RACFDCoupling.GetAirFlow()`](RACFDCoupling.md#generated.RACFDCoupling.GetAirFlow) * [`RACFDCoupling.GetCouplingMode()`](RACFDCoupling.md#generated.RACFDCoupling.GetCouplingMode) * [`RACFDCoupling.GetCouplingProcess()`](RACFDCoupling.md#generated.RACFDCoupling.GetCouplingProcess) * [`RACFDCoupling.GetOneWayLBM()`](RACFDCoupling.md#generated.RACFDCoupling.GetOneWayLBM) - * [`RACFDCoupling.SetupAirFlow()`](RACFDCoupling.md#generated.RACFDCoupling.SetupAirFlow) - * [`RACFDCoupling.SetupCFDConstantOneWayCouplingProcess()`](RACFDCoupling.md#generated.RACFDCoupling.SetupCFDConstantOneWayCouplingProcess) - * [`RACFDCoupling.SetupConstantOneWay()`](RACFDCoupling.md#generated.RACFDCoupling.SetupConstantOneWay) - * [`RACFDCoupling.SetupFluentOneWaySteadyState()`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentOneWaySteadyState) - * [`RACFDCoupling.SetupFluentTwoWay()`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentTwoWay) * [`RACFDCoupling.SetupFluentTwoWaySemiResolved()`](RACFDCoupling.md#generated.RACFDCoupling.SetupFluentTwoWaySemiResolved) * [`RACFDCoupling.SetupNoCoupling()`](RACFDCoupling.md#generated.RACFDCoupling.SetupNoCoupling) * [`RACFDCoupling.SetupOneWayConstant()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayConstant) * [`RACFDCoupling.SetupOneWayFluent()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayFluent) - * [`RACFDCoupling.SetupOneWayFluentSteadyState()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayFluentSteadyState) * [`RACFDCoupling.SetupOneWayLBM()`](RACFDCoupling.md#generated.RACFDCoupling.SetupOneWayLBM) * [`RACFDCoupling.SetupTwoWayFluent()`](RACFDCoupling.md#generated.RACFDCoupling.SetupTwoWayFluent) * [RACFDParametersList](RACFDParametersList.md) @@ -144,7 +180,6 @@ These are the classes and methods available to the user when executing scripts: * [`RACalculations.CreateDivisionsTagging()`](RACalculations.md#generated.RACalculations.CreateDivisionsTagging) * [`RACalculations.CreateSelectionFlipCount()`](RACalculations.md#generated.RACalculations.CreateSelectionFlipCount) * [`RACalculations.CreateSelectionResidenceTime()`](RACalculations.md#generated.RACalculations.CreateSelectionResidenceTime) - * [`RACalculations.CreateSelectionTagging()`](RACalculations.md#generated.RACalculations.CreateSelectionTagging) * [`RACalculations.CreateTagging()`](RACalculations.md#generated.RACalculations.CreateTagging) * [`RACalculations.GetDivisionsTagging()`](RACalculations.md#generated.RACalculations.GetDivisionsTagging) * [`RACalculations.GetDivisionsTaggingNames()`](RACalculations.md#generated.RACalculations.GetDivisionsTaggingNames) @@ -178,13 +213,17 @@ These are the classes and methods available to the user when executing scripts: * [`RACircularSurface.GetCurveNames()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNames) * [`RACircularSurface.GetCurveNamesAssociation()`](RACircularSurface.md#generated.RACircularSurface.GetCurveNamesAssociation) * [`RACircularSurface.GetElementCurve()`](RACircularSurface.md#generated.RACircularSurface.GetElementCurve) + * [`RACircularSurface.GetFacePositions()`](RACircularSurface.md#generated.RACircularSurface.GetFacePositions) + * [`RACircularSurface.GetFaceVertices()`](RACircularSurface.md#generated.RACircularSurface.GetFaceVertices) * [`RACircularSurface.GetGeometryQuantity()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryQuantity) + * [`RACircularSurface.GetGeometryTransform()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryTransform) * [`RACircularSurface.GetGeometryUnit()`](RACircularSurface.md#generated.RACircularSurface.GetGeometryUnit) * [`RACircularSurface.GetGridFunction()`](RACircularSurface.md#generated.RACircularSurface.GetGridFunction) * [`RACircularSurface.GetGridFunctionNames()`](RACircularSurface.md#generated.RACircularSurface.GetGridFunctionNames) * [`RACircularSurface.GetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.GetMaxRadius) * [`RACircularSurface.GetMeshColoring()`](RACircularSurface.md#generated.RACircularSurface.GetMeshColoring) * [`RACircularSurface.GetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.GetMinRadius) + * [`RACircularSurface.GetMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.GetMotionFrame) * [`RACircularSurface.GetNumberOfCells()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfCells) * [`RACircularSurface.GetNumberOfNodes()`](RACircularSurface.md#generated.RACircularSurface.GetNumberOfNodes) * [`RACircularSurface.GetNumpyCurve()`](RACircularSurface.md#generated.RACircularSurface.GetNumpyCurve) @@ -197,6 +236,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACircularSurface.GetTimeStatistics()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStatistics) * [`RACircularSurface.GetTimeStep()`](RACircularSurface.md#generated.RACircularSurface.GetTimeStep) * [`RACircularSurface.GetTopologyShape()`](RACircularSurface.md#generated.RACircularSurface.GetTopologyShape) + * [`RACircularSurface.GetVertices()`](RACircularSurface.md#generated.RACircularSurface.GetVertices) * [`RACircularSurface.HasGridFunction()`](RACircularSurface.md#generated.RACircularSurface.HasGridFunction) * [`RACircularSurface.HasMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.HasMotionFrame) * [`RACircularSurface.IsCellActive()`](RACircularSurface.md#generated.RACircularSurface.IsCellActive) @@ -211,6 +251,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACircularSurface.SetCurrentTimeStep()`](RACircularSurface.md#generated.RACircularSurface.SetCurrentTimeStep) * [`RACircularSurface.SetMaxRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMaxRadius) * [`RACircularSurface.SetMinRadius()`](RACircularSurface.md#generated.RACircularSurface.SetMinRadius) + * [`RACircularSurface.SetMotionFrame()`](RACircularSurface.md#generated.RACircularSurface.SetMotionFrame) * [`RACircularSurface.SetOrientation()`](RACircularSurface.md#generated.RACircularSurface.SetOrientation) * [`RACircularSurface.SetOrientationFromAngleAndVector()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngleAndVector) * [`RACircularSurface.SetOrientationFromAngles()`](RACircularSurface.md#generated.RACircularSurface.SetOrientationFromAngles) @@ -268,7 +309,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAConstantOneWayCoupling.GetDensity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDensity) * [`RAConstantOneWayCoupling.GetDragLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetDragLaw) * [`RAConstantOneWayCoupling.GetElementCurve()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetElementCurve) + * [`RAConstantOneWayCoupling.GetFacePositions()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetFacePositions) + * [`RAConstantOneWayCoupling.GetFaceVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetFaceVertices) * [`RAConstantOneWayCoupling.GetGeometryQuantity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryQuantity) + * [`RAConstantOneWayCoupling.GetGeometryTransform()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryTransform) * [`RAConstantOneWayCoupling.GetGeometryUnit()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGeometryUnit) * [`RAConstantOneWayCoupling.GetGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunction) * [`RAConstantOneWayCoupling.GetGridFunctionNames()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetGridFunctionNames) @@ -297,6 +341,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAConstantOneWayCoupling.GetUseTurbulentDispersion()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseTurbulentDispersion) * [`RAConstantOneWayCoupling.GetUseUserDefinedConstants()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetUseUserDefinedConstants) * [`RAConstantOneWayCoupling.GetVelocity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVelocity) + * [`RAConstantOneWayCoupling.GetVertices()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVertices) * [`RAConstantOneWayCoupling.GetVirtualMassLaw()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetVirtualMassLaw) * [`RAConstantOneWayCoupling.GetViscosity()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.GetViscosity) * [`RAConstantOneWayCoupling.HasGridFunction()`](RAConstantOneWayCoupling.md#generated.RAConstantOneWayCoupling.HasGridFunction) @@ -364,7 +409,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAContactData.GetCurveNames()`](RAContactData.md#generated.RAContactData.GetCurveNames) * [`RAContactData.GetCurveNamesAssociation()`](RAContactData.md#generated.RAContactData.GetCurveNamesAssociation) * [`RAContactData.GetElementCurve()`](RAContactData.md#generated.RAContactData.GetElementCurve) + * [`RAContactData.GetFacePositions()`](RAContactData.md#generated.RAContactData.GetFacePositions) + * [`RAContactData.GetFaceVertices()`](RAContactData.md#generated.RAContactData.GetFaceVertices) * [`RAContactData.GetGeometryQuantity()`](RAContactData.md#generated.RAContactData.GetGeometryQuantity) + * [`RAContactData.GetGeometryTransform()`](RAContactData.md#generated.RAContactData.GetGeometryTransform) * [`RAContactData.GetGeometryUnit()`](RAContactData.md#generated.RAContactData.GetGeometryUnit) * [`RAContactData.GetGridFunction()`](RAContactData.md#generated.RAContactData.GetGridFunction) * [`RAContactData.GetGridFunctionNames()`](RAContactData.md#generated.RAContactData.GetGridFunctionNames) @@ -378,6 +426,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAContactData.GetTimeStatistics()`](RAContactData.md#generated.RAContactData.GetTimeStatistics) * [`RAContactData.GetTimeStep()`](RAContactData.md#generated.RAContactData.GetTimeStep) * [`RAContactData.GetTopologyShape()`](RAContactData.md#generated.RAContactData.GetTopologyShape) + * [`RAContactData.GetVertices()`](RAContactData.md#generated.RAContactData.GetVertices) * [`RAContactData.HasGridFunction()`](RAContactData.md#generated.RAContactData.HasGridFunction) * [`RAContactData.IsCellActive()`](RAContactData.md#generated.RAContactData.IsCellActive) * [`RAContactData.IsCollectContactsDataEnabled()`](RAContactData.md#generated.RAContactData.IsCollectContactsDataEnabled) @@ -419,7 +468,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAContactToParticleProcess.GetCurveNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNames) * [`RAContactToParticleProcess.GetCurveNamesAssociation()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetCurveNamesAssociation) * [`RAContactToParticleProcess.GetElementCurve()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetElementCurve) + * [`RAContactToParticleProcess.GetFacePositions()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetFacePositions) + * [`RAContactToParticleProcess.GetFaceVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetFaceVertices) * [`RAContactToParticleProcess.GetGeometryQuantity()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryQuantity) + * [`RAContactToParticleProcess.GetGeometryTransform()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryTransform) * [`RAContactToParticleProcess.GetGeometryUnit()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGeometryUnit) * [`RAContactToParticleProcess.GetGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunction) * [`RAContactToParticleProcess.GetGridFunctionNames()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetGridFunctionNames) @@ -433,6 +485,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAContactToParticleProcess.GetTimeStatistics()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStatistics) * [`RAContactToParticleProcess.GetTimeStep()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTimeStep) * [`RAContactToParticleProcess.GetTopologyShape()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetTopologyShape) + * [`RAContactToParticleProcess.GetVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.GetVertices) * [`RAContactToParticleProcess.HasGridFunction()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.HasGridFunction) * [`RAContactToParticleProcess.IsCellActive()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IsCellActive) * [`RAContactToParticleProcess.IterCellVertices()`](RAContactToParticleProcess.md#generated.RAContactToParticleProcess.IterCellVertices) @@ -495,7 +548,10 @@ These are the classes and methods available to the user when executing scripts: * [`RACoupledWall.GetDisableTime()`](RACoupledWall.md#generated.RACoupledWall.GetDisableTime) * [`RACoupledWall.GetElementCurve()`](RACoupledWall.md#generated.RACoupledWall.GetElementCurve) * [`RACoupledWall.GetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.GetEnableTime) + * [`RACoupledWall.GetFacePositions()`](RACoupledWall.md#generated.RACoupledWall.GetFacePositions) + * [`RACoupledWall.GetFaceVertices()`](RACoupledWall.md#generated.RACoupledWall.GetFaceVertices) * [`RACoupledWall.GetGeometryQuantity()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryQuantity) + * [`RACoupledWall.GetGeometryTransform()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryTransform) * [`RACoupledWall.GetGeometryUnit()`](RACoupledWall.md#generated.RACoupledWall.GetGeometryUnit) * [`RACoupledWall.GetGridFunction()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunction) * [`RACoupledWall.GetGridFunctionNames()`](RACoupledWall.md#generated.RACoupledWall.GetGridFunctionNames) @@ -503,6 +559,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACoupledWall.GetMeshColoring()`](RACoupledWall.md#generated.RACoupledWall.GetMeshColoring) * [`RACoupledWall.GetModuleProperties()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperties) * [`RACoupledWall.GetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetModuleProperty) + * [`RACoupledWall.GetMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.GetMotionFrame) * [`RACoupledWall.GetNumberOfCells()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfCells) * [`RACoupledWall.GetNumberOfNodes()`](RACoupledWall.md#generated.RACoupledWall.GetNumberOfNodes) * [`RACoupledWall.GetNumpyCurve()`](RACoupledWall.md#generated.RACoupledWall.GetNumpyCurve) @@ -512,6 +569,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACoupledWall.GetTimeStep()`](RACoupledWall.md#generated.RACoupledWall.GetTimeStep) * [`RACoupledWall.GetTopologyShape()`](RACoupledWall.md#generated.RACoupledWall.GetTopologyShape) * [`RACoupledWall.GetValidOptionsForModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.GetValidOptionsForModuleProperty) + * [`RACoupledWall.GetVertices()`](RACoupledWall.md#generated.RACoupledWall.GetVertices) * [`RACoupledWall.HasGridFunction()`](RACoupledWall.md#generated.RACoupledWall.HasGridFunction) * [`RACoupledWall.HasMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.HasMotionFrame) * [`RACoupledWall.IsCellActive()`](RACoupledWall.md#generated.RACoupledWall.IsCellActive) @@ -527,6 +585,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACoupledWall.SetEnableTime()`](RACoupledWall.md#generated.RACoupledWall.SetEnableTime) * [`RACoupledWall.SetMaterial()`](RACoupledWall.md#generated.RACoupledWall.SetMaterial) * [`RACoupledWall.SetModuleProperty()`](RACoupledWall.md#generated.RACoupledWall.SetModuleProperty) + * [`RACoupledWall.SetMotionFrame()`](RACoupledWall.md#generated.RACoupledWall.SetMotionFrame) * [RACubeGroup](RACubeGroup.md) * [`RACubeGroup`](RACubeGroup.md#generated.RACubeGroup) * [`RACubeGroup.AddCurve()`](RACubeGroup.md#generated.RACubeGroup.AddCurve) @@ -577,14 +636,14 @@ These are the classes and methods available to the user when executing scripts: * [`RACubeProcess.GetCellVolumeAsArray()`](RACubeProcess.md#generated.RACubeProcess.GetCellVolumeAsArray) * [`RACubeProcess.GetCenter()`](RACubeProcess.md#generated.RACubeProcess.GetCenter) * [`RACubeProcess.GetCenterAfterMovement()`](RACubeProcess.md#generated.RACubeProcess.GetCenterAfterMovement) - * [`RACubeProcess.GetCubeCenter()`](RACubeProcess.md#generated.RACubeProcess.GetCubeCenter) - * [`RACubeProcess.GetCubeMagnitude()`](RACubeProcess.md#generated.RACubeProcess.GetCubeMagnitude) - * [`RACubeProcess.GetCubeRotation()`](RACubeProcess.md#generated.RACubeProcess.GetCubeRotation) * [`RACubeProcess.GetCurve()`](RACubeProcess.md#generated.RACubeProcess.GetCurve) * [`RACubeProcess.GetCurveNames()`](RACubeProcess.md#generated.RACubeProcess.GetCurveNames) * [`RACubeProcess.GetCurveNamesAssociation()`](RACubeProcess.md#generated.RACubeProcess.GetCurveNamesAssociation) * [`RACubeProcess.GetElementCurve()`](RACubeProcess.md#generated.RACubeProcess.GetElementCurve) + * [`RACubeProcess.GetFacePositions()`](RACubeProcess.md#generated.RACubeProcess.GetFacePositions) + * [`RACubeProcess.GetFaceVertices()`](RACubeProcess.md#generated.RACubeProcess.GetFaceVertices) * [`RACubeProcess.GetGeometryQuantity()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryQuantity) + * [`RACubeProcess.GetGeometryTransform()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryTransform) * [`RACubeProcess.GetGeometryUnit()`](RACubeProcess.md#generated.RACubeProcess.GetGeometryUnit) * [`RACubeProcess.GetGridFunction()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunction) * [`RACubeProcess.GetGridFunctionNames()`](RACubeProcess.md#generated.RACubeProcess.GetGridFunctionNames) @@ -605,6 +664,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACubeProcess.GetTimeStatistics()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStatistics) * [`RACubeProcess.GetTimeStep()`](RACubeProcess.md#generated.RACubeProcess.GetTimeStep) * [`RACubeProcess.GetTopologyShape()`](RACubeProcess.md#generated.RACubeProcess.GetTopologyShape) + * [`RACubeProcess.GetVertices()`](RACubeProcess.md#generated.RACubeProcess.GetVertices) * [`RACubeProcess.HasGridFunction()`](RACubeProcess.md#generated.RACubeProcess.HasGridFunction) * [`RACubeProcess.IsCellActive()`](RACubeProcess.md#generated.RACubeProcess.IsCellActive) * [`RACubeProcess.IterCellVertices()`](RACubeProcess.md#generated.RACubeProcess.IterCellVertices) @@ -616,9 +676,6 @@ These are the classes and methods available to the user when executing scripts: * [`RACubeProcess.RemoveOutputVariable()`](RACubeProcess.md#generated.RACubeProcess.RemoveOutputVariable) * [`RACubeProcess.RemoveProcess()`](RACubeProcess.md#generated.RACubeProcess.RemoveProcess) * [`RACubeProcess.SetCenter()`](RACubeProcess.md#generated.RACubeProcess.SetCenter) - * [`RACubeProcess.SetCubeCenter()`](RACubeProcess.md#generated.RACubeProcess.SetCubeCenter) - * [`RACubeProcess.SetCubeMagnitude()`](RACubeProcess.md#generated.RACubeProcess.SetCubeMagnitude) - * [`RACubeProcess.SetCubeRotation()`](RACubeProcess.md#generated.RACubeProcess.SetCubeRotation) * [`RACubeProcess.SetCurrentTimeStep()`](RACubeProcess.md#generated.RACubeProcess.SetCurrentTimeStep) * [`RACubeProcess.SetMotionFrame()`](RACubeProcess.md#generated.RACubeProcess.SetMotionFrame) * [`RACubeProcess.SetOrientation()`](RACubeProcess.md#generated.RACubeProcess.SetOrientation) @@ -627,6 +684,28 @@ These are the classes and methods available to the user when executing scripts: * [`RACubeProcess.SetOrientationFromBasisVector()`](RACubeProcess.md#generated.RACubeProcess.SetOrientationFromBasisVector) * [`RACubeProcess.SetRotation()`](RACubeProcess.md#generated.RACubeProcess.SetRotation) * [`RACubeProcess.SetSize()`](RACubeProcess.md#generated.RACubeProcess.SetSize) +* [RACurve](RACurve.md) + * [`RACurve`](RACurve.md#generated.RACurve) + * [`RACurve.CrossFromAbove()`](RACurve.md#generated.RACurve.CrossFromAbove) + * [`RACurve.CrossFromBellow()`](RACurve.md#generated.RACurve.CrossFromBellow) + * [`RACurve.GetStatistics()`](RACurve.md#generated.RACurve.GetStatistics) + * [`RACurve.GetTimeSet()`](RACurve.md#generated.RACurve.GetTimeSet) + * [`RACurve.GetUnit()`](RACurve.md#generated.RACurve.GetUnit) + * [`RACurve.GetX()`](RACurve.md#generated.RACurve.GetX) + * [`RACurve.GetXUnit()`](RACurve.md#generated.RACurve.GetXUnit) + * [`RACurve.GetY()`](RACurve.md#generated.RACurve.GetY) + * [`RACurve.Interpolate()`](RACurve.md#generated.RACurve.Interpolate) + * [`RACurve.Reset()`](RACurve.md#generated.RACurve.Reset) + * [`RACurve.SetFrequency()`](RACurve.md#generated.RACurve.SetFrequency) + * [`RACurve.SetUnit()`](RACurve.md#generated.RACurve.SetUnit) + * [`RACurve.SetXUnit()`](RACurve.md#generated.RACurve.SetXUnit) + * [`RACurve.curve_name`](RACurve.md#generated.RACurve.curve_name) + * [`RACurve.element_name`](RACurve.md#generated.RACurve.element_name) + * [`RACurve.simulation_name`](RACurve.md#generated.RACurve.simulation_name) + * [`RACurve.unit`](RACurve.md#generated.RACurve.unit) + * [`RACurve.x`](RACurve.md#generated.RACurve.x) + * [`RACurve.x_unit`](RACurve.md#generated.RACurve.x_unit) + * [`RACurve.y`](RACurve.md#generated.RACurve.y) * [RACustomInput](RACustomInput.md) * [`RACustomInput`](RACustomInput.md#generated.RACustomInput) * [`RACustomInput.GetAvailableMotionFrames()`](RACustomInput.md#generated.RACustomInput.GetAvailableMotionFrames) @@ -703,8 +782,11 @@ These are the classes and methods available to the user when executing scripts: * [`RACylinderProcess.GetCurveNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNames) * [`RACylinderProcess.GetCurveNamesAssociation()`](RACylinderProcess.md#generated.RACylinderProcess.GetCurveNamesAssociation) * [`RACylinderProcess.GetElementCurve()`](RACylinderProcess.md#generated.RACylinderProcess.GetElementCurve) + * [`RACylinderProcess.GetFacePositions()`](RACylinderProcess.md#generated.RACylinderProcess.GetFacePositions) + * [`RACylinderProcess.GetFaceVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetFaceVertices) * [`RACylinderProcess.GetFinalAngle()`](RACylinderProcess.md#generated.RACylinderProcess.GetFinalAngle) * [`RACylinderProcess.GetGeometryQuantity()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryQuantity) + * [`RACylinderProcess.GetGeometryTransform()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryTransform) * [`RACylinderProcess.GetGeometryUnit()`](RACylinderProcess.md#generated.RACylinderProcess.GetGeometryUnit) * [`RACylinderProcess.GetGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunction) * [`RACylinderProcess.GetGridFunctionNames()`](RACylinderProcess.md#generated.RACylinderProcess.GetGridFunctionNames) @@ -727,6 +809,7 @@ These are the classes and methods available to the user when executing scripts: * [`RACylinderProcess.GetTimeStatistics()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStatistics) * [`RACylinderProcess.GetTimeStep()`](RACylinderProcess.md#generated.RACylinderProcess.GetTimeStep) * [`RACylinderProcess.GetTopologyShape()`](RACylinderProcess.md#generated.RACylinderProcess.GetTopologyShape) + * [`RACylinderProcess.GetVertices()`](RACylinderProcess.md#generated.RACylinderProcess.GetVertices) * [`RACylinderProcess.HasGridFunction()`](RACylinderProcess.md#generated.RACylinderProcess.HasGridFunction) * [`RACylinderProcess.IsCellActive()`](RACylinderProcess.md#generated.RACylinderProcess.IsCellActive) * [`RACylinderProcess.IterCellVertices()`](RACylinderProcess.md#generated.RACylinderProcess.IterCellVertices) @@ -771,7 +854,6 @@ These are the classes and methods available to the user when executing scripts: * [`RADomainSettings.DisableUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.DisableUseBoundaryLimits) * [`RADomainSettings.EnablePeriodicAtGeometryLimits()`](RADomainSettings.md#generated.RADomainSettings.EnablePeriodicAtGeometryLimits) * [`RADomainSettings.EnableUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.EnableUseBoundaryLimits) - * [`RADomainSettings.GetBoundariesDirections()`](RADomainSettings.md#generated.RADomainSettings.GetBoundariesDirections) * [`RADomainSettings.GetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.GetCartesianPeriodicDirections) * [`RADomainSettings.GetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.GetCoordinateLimitsMaxValues) * [`RADomainSettings.GetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.GetCoordinateLimitsMinValues) @@ -783,13 +865,12 @@ These are the classes and methods available to the user when executing scripts: * [`RADomainSettings.GetPeriodicLimitsMaxCoordinates()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicLimitsMaxCoordinates) * [`RADomainSettings.GetPeriodicLimitsMinCoordinates()`](RADomainSettings.md#generated.RADomainSettings.GetPeriodicLimitsMinCoordinates) * [`RADomainSettings.GetUseBoundaryLimits()`](RADomainSettings.md#generated.RADomainSettings.GetUseBoundaryLimits) - * [`RADomainSettings.GetValidBoundariesDirectionsValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidBoundariesDirectionsValues) * [`RADomainSettings.GetValidCartesianPeriodicDirectionsValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidCartesianPeriodicDirectionsValues) * [`RADomainSettings.GetValidCylindricalPeriodicDirectionsValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidCylindricalPeriodicDirectionsValues) * [`RADomainSettings.GetValidDomainTypeValues()`](RADomainSettings.md#generated.RADomainSettings.GetValidDomainTypeValues) * [`RADomainSettings.IsPeriodicAtGeometryLimitsEnabled()`](RADomainSettings.md#generated.RADomainSettings.IsPeriodicAtGeometryLimitsEnabled) * [`RADomainSettings.IsUseBoundaryLimitsEnabled()`](RADomainSettings.md#generated.RADomainSettings.IsUseBoundaryLimitsEnabled) - * [`RADomainSettings.SetBoundariesDirections()`](RADomainSettings.md#generated.RADomainSettings.SetBoundariesDirections) + * [`RADomainSettings.ResetDomainToGeometriesLimits()`](RADomainSettings.md#generated.RADomainSettings.ResetDomainToGeometriesLimits) * [`RADomainSettings.SetCartesianPeriodicDirections()`](RADomainSettings.md#generated.RADomainSettings.SetCartesianPeriodicDirections) * [`RADomainSettings.SetCoordinateLimitsMaxValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMaxValues) * [`RADomainSettings.SetCoordinateLimitsMinValues()`](RADomainSettings.md#generated.RADomainSettings.SetCoordinateLimitsMinValues) @@ -831,7 +912,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAEulerianStatistics.GetCurveNamesAssociation()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetCurveNamesAssociation) * [`RAEulerianStatistics.GetDivisions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetDivisions) * [`RAEulerianStatistics.GetElementCurve()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetElementCurve) + * [`RAEulerianStatistics.GetFacePositions()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetFacePositions) + * [`RAEulerianStatistics.GetFaceVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetFaceVertices) * [`RAEulerianStatistics.GetGeometryQuantity()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryQuantity) + * [`RAEulerianStatistics.GetGeometryTransform()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryTransform) * [`RAEulerianStatistics.GetGeometryUnit()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGeometryUnit) * [`RAEulerianStatistics.GetGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunction) * [`RAEulerianStatistics.GetGridFunctionNames()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetGridFunctionNames) @@ -846,6 +930,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAEulerianStatistics.GetTimeStatistics()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStatistics) * [`RAEulerianStatistics.GetTimeStep()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTimeStep) * [`RAEulerianStatistics.GetTopologyShape()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetTopologyShape) + * [`RAEulerianStatistics.GetVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.GetVertices) * [`RAEulerianStatistics.HasGridFunction()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.HasGridFunction) * [`RAEulerianStatistics.IsCellActive()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IsCellActive) * [`RAEulerianStatistics.IterCellVertices()`](RAEulerianStatistics.md#generated.RAEulerianStatistics.IterCellVertices) @@ -892,6 +977,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFeedConveyor.GetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltThickness) * [`RAFeedConveyor.GetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBeltWidth) * [`RAFeedConveyor.GetBoundingBox()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetBoundingBox) + * [`RAFeedConveyor.GetCapillaryFrictionCoefficient()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCapillaryFrictionCoefficient) * [`RAFeedConveyor.GetCellAreaAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellAreaAsArray) * [`RAFeedConveyor.GetCellCenterAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellCenterAsArray) * [`RAFeedConveyor.GetCellDzAsArray()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetCellDzAsArray) @@ -909,9 +995,12 @@ These are the classes and methods available to the user when executing scripts: * [`RAFeedConveyor.GetDropBoxLength()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxLength) * [`RAFeedConveyor.GetDropBoxWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetDropBoxWidth) * [`RAFeedConveyor.GetElementCurve()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetElementCurve) + * [`RAFeedConveyor.GetFacePositions()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFacePositions) + * [`RAFeedConveyor.GetFaceVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceVertices) * [`RAFeedConveyor.GetFaceWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFaceWidth) * [`RAFeedConveyor.GetFrontPlateOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetFrontPlateOffset) * [`RAFeedConveyor.GetGeometryQuantity()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryQuantity) + * [`RAFeedConveyor.GetGeometryTransform()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryTransform) * [`RAFeedConveyor.GetGeometryUnit()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGeometryUnit) * [`RAFeedConveyor.GetGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunction) * [`RAFeedConveyor.GetGridFunctionNames()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetGridFunctionNames) @@ -947,6 +1036,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFeedConveyor.GetValidSphBoundaryTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidSphBoundaryTypeValues) * [`RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetValidThermalBoundaryConditionTypeValues) * [`RAFeedConveyor.GetVerticalOffset()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVerticalOffset) + * [`RAFeedConveyor.GetVertices()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetVertices) * [`RAFeedConveyor.GetWallThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWallThickness) * [`RAFeedConveyor.GetWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.GetWidth) * [`RAFeedConveyor.HasGridFunction()`](RAFeedConveyor.md#generated.RAFeedConveyor.HasGridFunction) @@ -967,6 +1057,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFeedConveyor.SetBeltSpeed()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltSpeed) * [`RAFeedConveyor.SetBeltThickness()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltThickness) * [`RAFeedConveyor.SetBeltWidth()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetBeltWidth) + * [`RAFeedConveyor.SetCapillaryFrictionCoefficient()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCapillaryFrictionCoefficient) * [`RAFeedConveyor.SetCurrentTimeStep()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetCurrentTimeStep) * [`RAFeedConveyor.SetDecelerationPeriod()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDecelerationPeriod) * [`RAFeedConveyor.SetDiameter()`](RAFeedConveyor.md#generated.RAFeedConveyor.SetDiameter) @@ -1023,7 +1114,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAFilterProcess.GetCurveNamesAssociation()`](RAFilterProcess.md#generated.RAFilterProcess.GetCurveNamesAssociation) * [`RAFilterProcess.GetCutValue()`](RAFilterProcess.md#generated.RAFilterProcess.GetCutValue) * [`RAFilterProcess.GetElementCurve()`](RAFilterProcess.md#generated.RAFilterProcess.GetElementCurve) + * [`RAFilterProcess.GetFacePositions()`](RAFilterProcess.md#generated.RAFilterProcess.GetFacePositions) + * [`RAFilterProcess.GetFaceVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetFaceVertices) * [`RAFilterProcess.GetGeometryQuantity()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryQuantity) + * [`RAFilterProcess.GetGeometryTransform()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryTransform) * [`RAFilterProcess.GetGeometryUnit()`](RAFilterProcess.md#generated.RAFilterProcess.GetGeometryUnit) * [`RAFilterProcess.GetGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunction) * [`RAFilterProcess.GetGridFunctionNames()`](RAFilterProcess.md#generated.RAFilterProcess.GetGridFunctionNames) @@ -1042,6 +1136,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFilterProcess.GetTimeStep()`](RAFilterProcess.md#generated.RAFilterProcess.GetTimeStep) * [`RAFilterProcess.GetTopologyShape()`](RAFilterProcess.md#generated.RAFilterProcess.GetTopologyShape) * [`RAFilterProcess.GetType()`](RAFilterProcess.md#generated.RAFilterProcess.GetType) + * [`RAFilterProcess.GetVertices()`](RAFilterProcess.md#generated.RAFilterProcess.GetVertices) * [`RAFilterProcess.HasGridFunction()`](RAFilterProcess.md#generated.RAFilterProcess.HasGridFunction) * [`RAFilterProcess.IsCellActive()`](RAFilterProcess.md#generated.RAFilterProcess.IsCellActive) * [`RAFilterProcess.IterCellVertices()`](RAFilterProcess.md#generated.RAFilterProcess.IterCellVertices) @@ -1113,7 +1208,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentOneWayCoupling.GetCurveNamesAssociation()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetCurveNamesAssociation) * [`RAFluentOneWayCoupling.GetDragLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetDragLaw) * [`RAFluentOneWayCoupling.GetElementCurve()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetElementCurve) + * [`RAFluentOneWayCoupling.GetFacePositions()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetFacePositions) + * [`RAFluentOneWayCoupling.GetFaceVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetFaceVertices) * [`RAFluentOneWayCoupling.GetGeometryQuantity()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryQuantity) + * [`RAFluentOneWayCoupling.GetGeometryTransform()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryTransform) * [`RAFluentOneWayCoupling.GetGeometryUnit()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGeometryUnit) * [`RAFluentOneWayCoupling.GetGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunction) * [`RAFluentOneWayCoupling.GetGridFunctionNames()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetGridFunctionNames) @@ -1139,6 +1237,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentOneWayCoupling.GetUseTurbulentDispersion()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseTurbulentDispersion) * [`RAFluentOneWayCoupling.GetUseUserDefinedConstants()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUseUserDefinedConstants) * [`RAFluentOneWayCoupling.GetUserCfdUpdateDistance()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetUserCfdUpdateDistance) + * [`RAFluentOneWayCoupling.GetVertices()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVertices) * [`RAFluentOneWayCoupling.GetVirtualMassLaw()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.GetVirtualMassLaw) * [`RAFluentOneWayCoupling.HasGridFunction()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.HasGridFunction) * [`RAFluentOneWayCoupling.IsCellActive()`](RAFluentOneWayCoupling.md#generated.RAFluentOneWayCoupling.IsCellActive) @@ -1232,6 +1331,8 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentTwoWayCoupling.GetDiffusionCoefficient()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDiffusionCoefficient) * [`RAFluentTwoWayCoupling.GetDragLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetDragLaw) * [`RAFluentTwoWayCoupling.GetElementCurve()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetElementCurve) + * [`RAFluentTwoWayCoupling.GetFacePositions()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFacePositions) + * [`RAFluentTwoWayCoupling.GetFaceVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFaceVertices) * [`RAFluentTwoWayCoupling.GetFluentAdditionalArgs()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentAdditionalArgs) * [`RAFluentTwoWayCoupling.GetFluentExecutionMode()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentExecutionMode) * [`RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentOutputFrequencyMultiplier) @@ -1240,6 +1341,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentTwoWayCoupling.GetFluentVersion()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFluentVersion) * [`RAFluentTwoWayCoupling.GetFractionParticleSize()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetFractionParticleSize) * [`RAFluentTwoWayCoupling.GetGeometryQuantity()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryQuantity) + * [`RAFluentTwoWayCoupling.GetGeometryTransform()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryTransform) * [`RAFluentTwoWayCoupling.GetGeometryUnit()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGeometryUnit) * [`RAFluentTwoWayCoupling.GetGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunction) * [`RAFluentTwoWayCoupling.GetGridFunctionNames()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetGridFunctionNames) @@ -1249,7 +1351,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentTwoWayCoupling.GetMaximumResidualTolerance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumResidualTolerance) * [`RAFluentTwoWayCoupling.GetMaximumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumTimeSteps) * [`RAFluentTwoWayCoupling.GetMaximumVolumeFraction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFraction) - * [`RAFluentTwoWayCoupling.GetMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMaximumVolumeFractionTarget) * [`RAFluentTwoWayCoupling.GetMeshColoring()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMeshColoring) * [`RAFluentTwoWayCoupling.GetMinimumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMinimumIterations) * [`RAFluentTwoWayCoupling.GetMinimumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetMinimumTimeSteps) @@ -1280,6 +1381,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidAveragingRadiusTypeValues) * [`RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidFluentExecutionModeValues) * [`RAFluentTwoWayCoupling.GetValidMappingMethodValues()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetValidMappingMethodValues) + * [`RAFluentTwoWayCoupling.GetVertices()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVertices) * [`RAFluentTwoWayCoupling.GetVirtualMassLaw()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVirtualMassLaw) * [`RAFluentTwoWayCoupling.GetVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.GetVolumeFractionTarget) * [`RAFluentTwoWayCoupling.HasGridFunction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.HasGridFunction) @@ -1316,7 +1418,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentTwoWayCoupling.SetMaximumResidualTolerance()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumResidualTolerance) * [`RAFluentTwoWayCoupling.SetMaximumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumTimeSteps) * [`RAFluentTwoWayCoupling.SetMaximumVolumeFraction()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFraction) - * [`RAFluentTwoWayCoupling.SetMaximumVolumeFractionTarget()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMaximumVolumeFractionTarget) * [`RAFluentTwoWayCoupling.SetMinimumIterations()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMinimumIterations) * [`RAFluentTwoWayCoupling.SetMinimumTimeSteps()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMinimumTimeSteps) * [`RAFluentTwoWayCoupling.SetMorsiAndAlexanderK1()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.SetMorsiAndAlexanderK1) @@ -1342,18 +1443,27 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluentTwoWayCoupling.UpdateFluentInfo()`](RAFluentTwoWayCoupling.md#generated.RAFluentTwoWayCoupling.UpdateFluentInfo) * [RAFluidInlet](RAFluidInlet.md) * [`RAFluidInlet`](RAFluidInlet.md#generated.RAFluidInlet) + * [`RAFluidInlet.DisablePeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.DisablePeriodic) + * [`RAFluidInlet.EnablePeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.EnablePeriodic) * [`RAFluidInlet.GetAvailableEntryPoints()`](RAFluidInlet.md#generated.RAFluidInlet.GetAvailableEntryPoints) * [`RAFluidInlet.GetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.GetBoundaryCondition) * [`RAFluidInlet.GetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.GetEntryPoint) + * [`RAFluidInlet.GetInjectionDuration()`](RAFluidInlet.md#generated.RAFluidInlet.GetInjectionDuration) * [`RAFluidInlet.GetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.GetMassFlowRate) + * [`RAFluidInlet.GetPeriod()`](RAFluidInlet.md#generated.RAFluidInlet.GetPeriod) + * [`RAFluidInlet.GetPeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.GetPeriodic) * [`RAFluidInlet.GetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.GetStartTime) * [`RAFluidInlet.GetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.GetStopTime) * [`RAFluidInlet.GetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.GetTemperature) * [`RAFluidInlet.GetValidBoundaryConditionValues()`](RAFluidInlet.md#generated.RAFluidInlet.GetValidBoundaryConditionValues) * [`RAFluidInlet.GetVelocity()`](RAFluidInlet.md#generated.RAFluidInlet.GetVelocity) + * [`RAFluidInlet.IsPeriodicEnabled()`](RAFluidInlet.md#generated.RAFluidInlet.IsPeriodicEnabled) * [`RAFluidInlet.SetBoundaryCondition()`](RAFluidInlet.md#generated.RAFluidInlet.SetBoundaryCondition) * [`RAFluidInlet.SetEntryPoint()`](RAFluidInlet.md#generated.RAFluidInlet.SetEntryPoint) + * [`RAFluidInlet.SetInjectionDuration()`](RAFluidInlet.md#generated.RAFluidInlet.SetInjectionDuration) * [`RAFluidInlet.SetMassFlowRate()`](RAFluidInlet.md#generated.RAFluidInlet.SetMassFlowRate) + * [`RAFluidInlet.SetPeriod()`](RAFluidInlet.md#generated.RAFluidInlet.SetPeriod) + * [`RAFluidInlet.SetPeriodic()`](RAFluidInlet.md#generated.RAFluidInlet.SetPeriodic) * [`RAFluidInlet.SetStartTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStartTime) * [`RAFluidInlet.SetStopTime()`](RAFluidInlet.md#generated.RAFluidInlet.SetStopTime) * [`RAFluidInlet.SetTemperature()`](RAFluidInlet.md#generated.RAFluidInlet.SetTemperature) @@ -1363,14 +1473,12 @@ These are the classes and methods available to the user when executing scripts: * [`RAFluidMaterial.GetDensity()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetDensity) * [`RAFluidMaterial.GetModuleProperties()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetModuleProperties) * [`RAFluidMaterial.GetModuleProperty()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetModuleProperty) - * [`RAFluidMaterial.GetSoundSpeed()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetSoundSpeed) * [`RAFluidMaterial.GetSpecificHeat()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetSpecificHeat) * [`RAFluidMaterial.GetThermalConductivity()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetThermalConductivity) * [`RAFluidMaterial.GetValidOptionsForModuleProperty()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetValidOptionsForModuleProperty) * [`RAFluidMaterial.GetViscosity()`](RAFluidMaterial.md#generated.RAFluidMaterial.GetViscosity) * [`RAFluidMaterial.SetDensity()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetDensity) * [`RAFluidMaterial.SetModuleProperty()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetModuleProperty) - * [`RAFluidMaterial.SetSoundSpeed()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetSoundSpeed) * [`RAFluidMaterial.SetSpecificHeat()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetSpecificHeat) * [`RAFluidMaterial.SetThermalConductivity()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetThermalConductivity) * [`RAFluidMaterial.SetViscosity()`](RAFluidMaterial.md#generated.RAFluidMaterial.SetViscosity) @@ -1386,15 +1494,48 @@ These are the classes and methods available to the user when executing scripts: * [`RAFreeBodyTranslation.SetFreeMotionDirection()`](RAFreeBodyTranslation.md#generated.RAFreeBodyTranslation.SetFreeMotionDirection) * [RAGeometryCollection](RAGeometryCollection.md) * [`RAGeometryCollection`](RAGeometryCollection.md#generated.RAGeometryCollection) + * [`RAGeometryCollection.Clear()`](RAGeometryCollection.md#generated.RAGeometryCollection.Clear) * [`RAGeometryCollection.GetBoundingBox()`](RAGeometryCollection.md#generated.RAGeometryCollection.GetBoundingBox) * [`RAGeometryCollection.GetGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.GetGeometry) * [`RAGeometryCollection.GetGeometryNames()`](RAGeometryCollection.md#generated.RAGeometryCollection.GetGeometryNames) * [`RAGeometryCollection.IterInletGeometries()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterInletGeometries) - * [`RAGeometryCollection.IterInputGeometries()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterInputGeometries) * [`RAGeometryCollection.IterSurfaces()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterSurfaces) * [`RAGeometryCollection.IterSystemCouplingWalls()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterSystemCouplingWalls) * [`RAGeometryCollection.IterWalls()`](RAGeometryCollection.md#generated.RAGeometryCollection.IterWalls) + * [`RAGeometryCollection.New()`](RAGeometryCollection.md#generated.RAGeometryCollection.New) + * [`RAGeometryCollection.Remove()`](RAGeometryCollection.md#generated.RAGeometryCollection.Remove) * [`RAGeometryCollection.RemoveGeometry()`](RAGeometryCollection.md#generated.RAGeometryCollection.RemoveGeometry) +* [RAGridFunction](RAGridFunction.md) + * [`RAGridFunction`](RAGridFunction.md#generated.RAGridFunction) + * [`RAGridFunction.GetArray()`](RAGridFunction.md#generated.RAGridFunction.GetArray) + * [`RAGridFunction.GetAverage()`](RAGridFunction.md#generated.RAGridFunction.GetAverage) + * [`RAGridFunction.GetGrid()`](RAGridFunction.md#generated.RAGridFunction.GetGrid) + * [`RAGridFunction.GetIsStatic()`](RAGridFunction.md#generated.RAGridFunction.GetIsStatic) + * [`RAGridFunction.GetIsTransient()`](RAGridFunction.md#generated.RAGridFunction.GetIsTransient) + * [`RAGridFunction.GetLimits()`](RAGridFunction.md#generated.RAGridFunction.GetLimits) + * [`RAGridFunction.GetLocation()`](RAGridFunction.md#generated.RAGridFunction.GetLocation) + * [`RAGridFunction.GetMax()`](RAGridFunction.md#generated.RAGridFunction.GetMax) + * [`RAGridFunction.GetMin()`](RAGridFunction.md#generated.RAGridFunction.GetMin) + * [`RAGridFunction.GetStandardDeviation()`](RAGridFunction.md#generated.RAGridFunction.GetStandardDeviation) + * [`RAGridFunction.GetSum()`](RAGridFunction.md#generated.RAGridFunction.GetSum) + * [`RAGridFunction.GetSumSquared()`](RAGridFunction.md#generated.RAGridFunction.GetSumSquared) + * [`RAGridFunction.GetTimeStep()`](RAGridFunction.md#generated.RAGridFunction.GetTimeStep) + * [`RAGridFunction.GetUnit()`](RAGridFunction.md#generated.RAGridFunction.GetUnit) + * [`RAGridFunction.GetValue()`](RAGridFunction.md#generated.RAGridFunction.GetValue) + * [`RAGridFunction.GetVariance()`](RAGridFunction.md#generated.RAGridFunction.GetVariance) + * [`RAGridFunction.Modified()`](RAGridFunction.md#generated.RAGridFunction.Modified) + * [`RAGridFunction.SetCurrentTimeStep()`](RAGridFunction.md#generated.RAGridFunction.SetCurrentTimeStep) + * [`RAGridFunction.average`](RAGridFunction.md#generated.RAGridFunction.average) + * [`RAGridFunction.is_static`](RAGridFunction.md#generated.RAGridFunction.is_static) + * [`RAGridFunction.is_transient`](RAGridFunction.md#generated.RAGridFunction.is_transient) + * [`RAGridFunction.limits`](RAGridFunction.md#generated.RAGridFunction.limits) + * [`RAGridFunction.max`](RAGridFunction.md#generated.RAGridFunction.max) + * [`RAGridFunction.min`](RAGridFunction.md#generated.RAGridFunction.min) + * [`RAGridFunction.standard_deviation`](RAGridFunction.md#generated.RAGridFunction.standard_deviation) + * [`RAGridFunction.sum`](RAGridFunction.md#generated.RAGridFunction.sum) + * [`RAGridFunction.sum_squared`](RAGridFunction.md#generated.RAGridFunction.sum_squared) + * [`RAGridFunction.unit`](RAGridFunction.md#generated.RAGridFunction.unit) + * [`RAGridFunction.variance`](RAGridFunction.md#generated.RAGridFunction.variance) * [RAInletGeometry](RAInletGeometry.md) * [`RAInletGeometry`](RAInletGeometry.md#generated.RAInletGeometry) * [`RAInletGeometry.AddCurve()`](RAInletGeometry.md#generated.RAInletGeometry.AddCurve) @@ -1425,7 +1566,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAInletGeometry.GetCurveNames()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNames) * [`RAInletGeometry.GetCurveNamesAssociation()`](RAInletGeometry.md#generated.RAInletGeometry.GetCurveNamesAssociation) * [`RAInletGeometry.GetElementCurve()`](RAInletGeometry.md#generated.RAInletGeometry.GetElementCurve) + * [`RAInletGeometry.GetFacePositions()`](RAInletGeometry.md#generated.RAInletGeometry.GetFacePositions) + * [`RAInletGeometry.GetFaceVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetFaceVertices) * [`RAInletGeometry.GetGeometryQuantity()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryQuantity) + * [`RAInletGeometry.GetGeometryTransform()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryTransform) * [`RAInletGeometry.GetGeometryType()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryType) * [`RAInletGeometry.GetGeometryUnit()`](RAInletGeometry.md#generated.RAInletGeometry.GetGeometryUnit) * [`RAInletGeometry.GetGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.GetGridFunction) @@ -1442,6 +1586,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAInletGeometry.GetTimeStatistics()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStatistics) * [`RAInletGeometry.GetTimeStep()`](RAInletGeometry.md#generated.RAInletGeometry.GetTimeStep) * [`RAInletGeometry.GetTopologyShape()`](RAInletGeometry.md#generated.RAInletGeometry.GetTopologyShape) + * [`RAInletGeometry.GetVertices()`](RAInletGeometry.md#generated.RAInletGeometry.GetVertices) * [`RAInletGeometry.GetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.GetWidth) * [`RAInletGeometry.HasGridFunction()`](RAInletGeometry.md#generated.RAInletGeometry.HasGridFunction) * [`RAInletGeometry.IsCellActive()`](RAInletGeometry.md#generated.RAInletGeometry.IsCellActive) @@ -1463,7 +1608,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAInletGeometry.SetWidth()`](RAInletGeometry.md#generated.RAInletGeometry.SetWidth) * [RAInletsOutletsCollection](RAInletsOutletsCollection.md) * [`RAInletsOutletsCollection`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection) - * [`RAInletsOutletsCollection.AddContinuousInjection()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddContinuousInjection) * [`RAInletsOutletsCollection.AddCustomInput()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddCustomInput) * [`RAInletsOutletsCollection.AddFluidInlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddFluidInlet) * [`RAInletsOutletsCollection.AddOutlet()`](RAInletsOutletsCollection.md#generated.RAInletsOutletsCollection.AddOutlet) @@ -1506,7 +1650,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAInspectorProcess.GetCurveNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNames) * [`RAInspectorProcess.GetCurveNamesAssociation()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetCurveNamesAssociation) * [`RAInspectorProcess.GetElementCurve()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetElementCurve) + * [`RAInspectorProcess.GetFacePositions()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetFacePositions) + * [`RAInspectorProcess.GetFaceVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetFaceVertices) * [`RAInspectorProcess.GetGeometryQuantity()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryQuantity) + * [`RAInspectorProcess.GetGeometryTransform()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryTransform) * [`RAInspectorProcess.GetGeometryUnit()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGeometryUnit) * [`RAInspectorProcess.GetGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunction) * [`RAInspectorProcess.GetGridFunctionNames()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetGridFunctionNames) @@ -1520,6 +1667,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAInspectorProcess.GetTimeStatistics()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStatistics) * [`RAInspectorProcess.GetTimeStep()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTimeStep) * [`RAInspectorProcess.GetTopologyShape()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetTopologyShape) + * [`RAInspectorProcess.GetVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.GetVertices) * [`RAInspectorProcess.HasGridFunction()`](RAInspectorProcess.md#generated.RAInspectorProcess.HasGridFunction) * [`RAInspectorProcess.IsCellActive()`](RAInspectorProcess.md#generated.RAInspectorProcess.IsCellActive) * [`RAInspectorProcess.IterCellVertices()`](RAInspectorProcess.md#generated.RAInspectorProcess.IterCellVertices) @@ -1568,10 +1716,8 @@ These are the classes and methods available to the user when executing scripts: * [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) * [`RAMaterialCollection.Clear()`](RAMaterialCollection.md#generated.RAMaterialCollection.Clear) * [`RAMaterialCollection.GetBulkSolidFraction()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetBulkSolidFraction) - * [`RAMaterialCollection.GetDefaultMaterials()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetDefaultMaterials) * [`RAMaterialCollection.GetDefaultSolidMaterials()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetDefaultSolidMaterials) * [`RAMaterialCollection.GetFluidMaterial()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetFluidMaterial) - * [`RAMaterialCollection.GetMaterial()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterial) * [`RAMaterialCollection.GetMaterialsInteractionCollection()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetMaterialsInteractionCollection) * [`RAMaterialCollection.GetSolidMaterial()`](RAMaterialCollection.md#generated.RAMaterialCollection.GetSolidMaterial) * [`RAMaterialCollection.New()`](RAMaterialCollection.md#generated.RAMaterialCollection.New) @@ -1713,7 +1859,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAModuleOutput.GetCurveNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNames) * [`RAModuleOutput.GetCurveNamesAssociation()`](RAModuleOutput.md#generated.RAModuleOutput.GetCurveNamesAssociation) * [`RAModuleOutput.GetElementCurve()`](RAModuleOutput.md#generated.RAModuleOutput.GetElementCurve) + * [`RAModuleOutput.GetFacePositions()`](RAModuleOutput.md#generated.RAModuleOutput.GetFacePositions) + * [`RAModuleOutput.GetFaceVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetFaceVertices) * [`RAModuleOutput.GetGeometryQuantity()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryQuantity) + * [`RAModuleOutput.GetGeometryTransform()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryTransform) * [`RAModuleOutput.GetGeometryUnit()`](RAModuleOutput.md#generated.RAModuleOutput.GetGeometryUnit) * [`RAModuleOutput.GetGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunction) * [`RAModuleOutput.GetGridFunctionNames()`](RAModuleOutput.md#generated.RAModuleOutput.GetGridFunctionNames) @@ -1726,6 +1875,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAModuleOutput.GetTimeStatistics()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStatistics) * [`RAModuleOutput.GetTimeStep()`](RAModuleOutput.md#generated.RAModuleOutput.GetTimeStep) * [`RAModuleOutput.GetTopologyShape()`](RAModuleOutput.md#generated.RAModuleOutput.GetTopologyShape) + * [`RAModuleOutput.GetVertices()`](RAModuleOutput.md#generated.RAModuleOutput.GetVertices) * [`RAModuleOutput.HasGridFunction()`](RAModuleOutput.md#generated.RAModuleOutput.HasGridFunction) * [`RAModuleOutput.IsCellActive()`](RAModuleOutput.md#generated.RAModuleOutput.IsCellActive) * [`RAModuleOutput.IterCellVertices()`](RAModuleOutput.md#generated.RAModuleOutput.IterCellVertices) @@ -1762,6 +1912,8 @@ These are the classes and methods available to the user when executing scripts: * [`RAMotionFrame.AddCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCurve) * [`RAMotionFrame.AddCustomCurve()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomCurve) * [`RAMotionFrame.AddCustomProperty()`](RAMotionFrame.md#generated.RAMotionFrame.AddCustomProperty) + * [`RAMotionFrame.AddFreeBodyRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddFreeBodyRotationMotion) + * [`RAMotionFrame.AddFreeBodyTranslationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddFreeBodyTranslationMotion) * [`RAMotionFrame.AddGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.AddGridFunction) * [`RAMotionFrame.AddPendulumMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddPendulumMotion) * [`RAMotionFrame.AddRotationMotion()`](RAMotionFrame.md#generated.RAMotionFrame.AddRotationMotion) @@ -1792,11 +1944,14 @@ These are the classes and methods available to the user when executing scripts: * [`RAMotionFrame.GetEnableFbmAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmAngularLimits) * [`RAMotionFrame.GetEnableFbmLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnableFbmLinearLimits) * [`RAMotionFrame.GetEnablePeriodicMotion()`](RAMotionFrame.md#generated.RAMotionFrame.GetEnablePeriodicMotion) + * [`RAMotionFrame.GetFacePositions()`](RAMotionFrame.md#generated.RAMotionFrame.GetFacePositions) + * [`RAMotionFrame.GetFaceVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetFaceVertices) * [`RAMotionFrame.GetFbmMaxAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMaxAngularLimits) * [`RAMotionFrame.GetFbmMaxLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMaxLinearLimits) * [`RAMotionFrame.GetFbmMinAngularLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMinAngularLimits) * [`RAMotionFrame.GetFbmMinLinearLimits()`](RAMotionFrame.md#generated.RAMotionFrame.GetFbmMinLinearLimits) * [`RAMotionFrame.GetGeometryQuantity()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryQuantity) + * [`RAMotionFrame.GetGeometryTransform()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryTransform) * [`RAMotionFrame.GetGeometryUnit()`](RAMotionFrame.md#generated.RAMotionFrame.GetGeometryUnit) * [`RAMotionFrame.GetGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunction) * [`RAMotionFrame.GetGridFunctionNames()`](RAMotionFrame.md#generated.RAMotionFrame.GetGridFunctionNames) @@ -1817,12 +1972,11 @@ These are the classes and methods available to the user when executing scripts: * [`RAMotionFrame.GetPeriodicMotionStartTime()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionStartTime) * [`RAMotionFrame.GetPeriodicMotionStopTime()`](RAMotionFrame.md#generated.RAMotionFrame.GetPeriodicMotionStopTime) * [`RAMotionFrame.GetRelativePosition()`](RAMotionFrame.md#generated.RAMotionFrame.GetRelativePosition) - * [`RAMotionFrame.GetRelativeRotationVector()`](RAMotionFrame.md#generated.RAMotionFrame.GetRelativeRotationVector) - * [`RAMotionFrame.GetRotationAngle()`](RAMotionFrame.md#generated.RAMotionFrame.GetRotationAngle) * [`RAMotionFrame.GetTimeSet()`](RAMotionFrame.md#generated.RAMotionFrame.GetTimeSet) * [`RAMotionFrame.GetTimeStatistics()`](RAMotionFrame.md#generated.RAMotionFrame.GetTimeStatistics) * [`RAMotionFrame.GetTimeStep()`](RAMotionFrame.md#generated.RAMotionFrame.GetTimeStep) * [`RAMotionFrame.GetTopologyShape()`](RAMotionFrame.md#generated.RAMotionFrame.GetTopologyShape) + * [`RAMotionFrame.GetVertices()`](RAMotionFrame.md#generated.RAMotionFrame.GetVertices) * [`RAMotionFrame.HasGridFunction()`](RAMotionFrame.md#generated.RAMotionFrame.HasGridFunction) * [`RAMotionFrame.IsCellActive()`](RAMotionFrame.md#generated.RAMotionFrame.IsCellActive) * [`RAMotionFrame.IterCellVertices()`](RAMotionFrame.md#generated.RAMotionFrame.IterCellVertices) @@ -1853,8 +2007,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAMotionFrame.SetPeriodicMotionStartTime()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionStartTime) * [`RAMotionFrame.SetPeriodicMotionStopTime()`](RAMotionFrame.md#generated.RAMotionFrame.SetPeriodicMotionStopTime) * [`RAMotionFrame.SetRelativePosition()`](RAMotionFrame.md#generated.RAMotionFrame.SetRelativePosition) - * [`RAMotionFrame.SetRelativeRotationVector()`](RAMotionFrame.md#generated.RAMotionFrame.SetRelativeRotationVector) - * [`RAMotionFrame.SetRotationAngle()`](RAMotionFrame.md#generated.RAMotionFrame.SetRotationAngle) * [RAMotionFrameSource](RAMotionFrameSource.md) * [`RAMotionFrameSource`](RAMotionFrameSource.md#generated.RAMotionFrameSource) * [`RAMotionFrameSource.GetMotionFrame()`](RAMotionFrameSource.md#generated.RAMotionFrameSource.GetMotionFrame) @@ -1923,6 +2075,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticle.GetActivesArray()`](RAParticle.md#generated.RAParticle.GetActivesArray) * [`RAParticle.GetAllowSelfContacts()`](RAParticle.md#generated.RAParticle.GetAllowSelfContacts) * [`RAParticle.GetAnisotropic()`](RAParticle.md#generated.RAParticle.GetAnisotropic) + * [`RAParticle.GetAssemblyCustom()`](RAParticle.md#generated.RAParticle.GetAssemblyCustom) * [`RAParticle.GetAvailableMaterials()`](RAParticle.md#generated.RAParticle.GetAvailableMaterials) * [`RAParticle.GetBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetBendingAngleLimit) * [`RAParticle.GetBoundingBox()`](RAParticle.md#generated.RAParticle.GetBoundingBox) @@ -1954,9 +2107,12 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticle.GetEnableBreakage()`](RAParticle.md#generated.RAParticle.GetEnableBreakage) * [`RAParticle.GetEnableRandomAngle()`](RAParticle.md#generated.RAParticle.GetEnableRandomAngle) * [`RAParticle.GetEnableRotations()`](RAParticle.md#generated.RAParticle.GetEnableRotations) + * [`RAParticle.GetFacePositions()`](RAParticle.md#generated.RAParticle.GetFacePositions) + * [`RAParticle.GetFaceVertices()`](RAParticle.md#generated.RAParticle.GetFaceVertices) * [`RAParticle.GetFailureRatio()`](RAParticle.md#generated.RAParticle.GetFailureRatio) * [`RAParticle.GetFlexible()`](RAParticle.md#generated.RAParticle.GetFlexible) * [`RAParticle.GetGeometryQuantity()`](RAParticle.md#generated.RAParticle.GetGeometryQuantity) + * [`RAParticle.GetGeometryTransform()`](RAParticle.md#generated.RAParticle.GetGeometryTransform) * [`RAParticle.GetGeometryUnit()`](RAParticle.md#generated.RAParticle.GetGeometryUnit) * [`RAParticle.GetGridFunction()`](RAParticle.md#generated.RAParticle.GetGridFunction) * [`RAParticle.GetGridFunctionNames()`](RAParticle.md#generated.RAParticle.GetGridFunctionNames) @@ -1991,8 +2147,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticle.GetRatioEnergyAfterBreakage()`](RAParticle.md#generated.RAParticle.GetRatioEnergyAfterBreakage) * [`RAParticle.GetRemeshToTarget()`](RAParticle.md#generated.RAParticle.GetRemeshToTarget) * [`RAParticle.GetRollingResistance()`](RAParticle.md#generated.RAParticle.GetRollingResistance) - * [`RAParticle.GetRotationAngle()`](RAParticle.md#generated.RAParticle.GetRotationAngle) - * [`RAParticle.GetRotationVector()`](RAParticle.md#generated.RAParticle.GetRotationVector) * [`RAParticle.GetSecondBendingAngleLimit()`](RAParticle.md#generated.RAParticle.GetSecondBendingAngleLimit) * [`RAParticle.GetShape()`](RAParticle.md#generated.RAParticle.GetShape) * [`RAParticle.GetShearStressLimit()`](RAParticle.md#generated.RAParticle.GetShearStressLimit) @@ -2031,6 +2185,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticle.GetValidSizeTypeValues()`](RAParticle.md#generated.RAParticle.GetValidSizeTypeValues) * [`RAParticle.GetValidT10FormulaValues()`](RAParticle.md#generated.RAParticle.GetValidT10FormulaValues) * [`RAParticle.GetVerticalAspectRatio()`](RAParticle.md#generated.RAParticle.GetVerticalAspectRatio) + * [`RAParticle.GetVertices()`](RAParticle.md#generated.RAParticle.GetVertices) * [`RAParticle.GetVonMisesStressLimit()`](RAParticle.md#generated.RAParticle.GetVonMisesStressLimit) * [`RAParticle.GetWithFailure()`](RAParticle.md#generated.RAParticle.GetWithFailure) * [`RAParticle.GetXDirection()`](RAParticle.md#generated.RAParticle.GetXDirection) @@ -2038,7 +2193,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticle.GetZDirection()`](RAParticle.md#generated.RAParticle.GetZDirection) * [`RAParticle.HasGridFunction()`](RAParticle.md#generated.RAParticle.HasGridFunction) * [`RAParticle.ImportCustomFiber()`](RAParticle.md#generated.RAParticle.ImportCustomFiber) - * [`RAParticle.ImportFiberFromTXT()`](RAParticle.md#generated.RAParticle.ImportFiberFromTXT) * [`RAParticle.ImportFromSTL()`](RAParticle.md#generated.RAParticle.ImportFromSTL) * [`RAParticle.IsBreakageEnabled()`](RAParticle.md#generated.RAParticle.IsBreakageEnabled) * [`RAParticle.IsCellActive()`](RAParticle.md#generated.RAParticle.IsCellActive) @@ -2104,8 +2258,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticle.SetRatioEnergyAfterBreakage()`](RAParticle.md#generated.RAParticle.SetRatioEnergyAfterBreakage) * [`RAParticle.SetRemeshToTarget()`](RAParticle.md#generated.RAParticle.SetRemeshToTarget) * [`RAParticle.SetRollingResistance()`](RAParticle.md#generated.RAParticle.SetRollingResistance) - * [`RAParticle.SetRotationAngle()`](RAParticle.md#generated.RAParticle.SetRotationAngle) - * [`RAParticle.SetRotationVector()`](RAParticle.md#generated.RAParticle.SetRotationVector) * [`RAParticle.SetSecondBendingAngleLimit()`](RAParticle.md#generated.RAParticle.SetSecondBendingAngleLimit) * [`RAParticle.SetShape()`](RAParticle.md#generated.RAParticle.SetShape) * [`RAParticle.SetShearStressLimit()`](RAParticle.md#generated.RAParticle.SetShearStressLimit) @@ -2170,47 +2322,41 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleCollection.Remove()`](RAParticleCollection.md#generated.RAParticleCollection.Remove) * [RAParticleInlet](RAParticleInlet.md) * [`RAParticleInlet`](RAParticleInlet.md#generated.RAParticleInlet) + * [`RAParticleInlet.AddParticle()`](RAParticleInlet.md#generated.RAParticleInlet.AddParticle) * [`RAParticleInlet.DisableForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.DisableForcePacking) * [`RAParticleInlet.DisablePeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.DisablePeriodic) - * [`RAParticleInlet.DisablePeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.DisablePeriodicDischarge) * [`RAParticleInlet.DisableStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.DisableStopAllAtStopTime) * [`RAParticleInlet.DisableUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.DisableUseTargetNormalVelocity) * [`RAParticleInlet.EnableForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.EnableForcePacking) * [`RAParticleInlet.EnablePeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.EnablePeriodic) - * [`RAParticleInlet.EnablePeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.EnablePeriodicDischarge) * [`RAParticleInlet.EnableStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.EnableStopAllAtStopTime) * [`RAParticleInlet.EnableUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.EnableUseTargetNormalVelocity) * [`RAParticleInlet.GetAvailableEntryPoints()`](RAParticleInlet.md#generated.RAParticleInlet.GetAvailableEntryPoints) - * [`RAParticleInlet.GetDischargeTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetDischargeTime) * [`RAParticleInlet.GetEntryPoint()`](RAParticleInlet.md#generated.RAParticleInlet.GetEntryPoint) * [`RAParticleInlet.GetForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.GetForcePacking) * [`RAParticleInlet.GetInjectionDuration()`](RAParticleInlet.md#generated.RAParticleInlet.GetInjectionDuration) * [`RAParticleInlet.GetInputPropertiesList()`](RAParticleInlet.md#generated.RAParticleInlet.GetInputPropertiesList) * [`RAParticleInlet.GetPeriod()`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriod) * [`RAParticleInlet.GetPeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriodic) - * [`RAParticleInlet.GetPeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.GetPeriodicDischarge) * [`RAParticleInlet.GetSphInjectionEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.GetSphInjectionEnabled) * [`RAParticleInlet.GetSphTemperature()`](RAParticleInlet.md#generated.RAParticleInlet.GetSphTemperature) * [`RAParticleInlet.GetStartTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetStartTime) * [`RAParticleInlet.GetStopAllAtStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetStopAllAtStopTime) * [`RAParticleInlet.GetStopTime()`](RAParticleInlet.md#generated.RAParticleInlet.GetStopTime) * [`RAParticleInlet.GetTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.GetTargetNormalVelocity) - * [`RAParticleInlet.GetTonnageList()`](RAParticleInlet.md#generated.RAParticleInlet.GetTonnageList) * [`RAParticleInlet.GetUseTargetNormalVelocity()`](RAParticleInlet.md#generated.RAParticleInlet.GetUseTargetNormalVelocity) * [`RAParticleInlet.GetUxLocal()`](RAParticleInlet.md#generated.RAParticleInlet.GetUxLocal) * [`RAParticleInlet.GetUzLocal()`](RAParticleInlet.md#generated.RAParticleInlet.GetUzLocal) * [`RAParticleInlet.IsForcePackingEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsForcePackingEnabled) - * [`RAParticleInlet.IsPeriodicDischargeEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsPeriodicDischargeEnabled) * [`RAParticleInlet.IsPeriodicEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsPeriodicEnabled) * [`RAParticleInlet.IsStopAllAtStopTimeEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsStopAllAtStopTimeEnabled) * [`RAParticleInlet.IsUseTargetNormalVelocityEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.IsUseTargetNormalVelocityEnabled) - * [`RAParticleInlet.SetDischargeTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetDischargeTime) + * [`RAParticleInlet.RemoveParticle()`](RAParticleInlet.md#generated.RAParticleInlet.RemoveParticle) * [`RAParticleInlet.SetEntryPoint()`](RAParticleInlet.md#generated.RAParticleInlet.SetEntryPoint) * [`RAParticleInlet.SetForcePacking()`](RAParticleInlet.md#generated.RAParticleInlet.SetForcePacking) * [`RAParticleInlet.SetInjectionDuration()`](RAParticleInlet.md#generated.RAParticleInlet.SetInjectionDuration) * [`RAParticleInlet.SetPeriod()`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriod) * [`RAParticleInlet.SetPeriodic()`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriodic) - * [`RAParticleInlet.SetPeriodicDischarge()`](RAParticleInlet.md#generated.RAParticleInlet.SetPeriodicDischarge) * [`RAParticleInlet.SetSphInjectionEnabled()`](RAParticleInlet.md#generated.RAParticleInlet.SetSphInjectionEnabled) * [`RAParticleInlet.SetSphTemperature()`](RAParticleInlet.md#generated.RAParticleInlet.SetSphTemperature) * [`RAParticleInlet.SetStartTime()`](RAParticleInlet.md#generated.RAParticleInlet.SetStartTime) @@ -2228,13 +2374,11 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleInletProperties.GetModuleProperty()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetModuleProperty) * [`RAParticleInletProperties.GetParticle()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetParticle) * [`RAParticleInletProperties.GetTemperature()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetTemperature) - * [`RAParticleInletProperties.GetTonnage()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetTonnage) * [`RAParticleInletProperties.GetValidOptionsForModuleProperty()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.GetValidOptionsForModuleProperty) * [`RAParticleInletProperties.SetMassFlowRate()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetMassFlowRate) * [`RAParticleInletProperties.SetModuleProperty()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetModuleProperty) * [`RAParticleInletProperties.SetParticle()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetParticle) * [`RAParticleInletProperties.SetTemperature()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetTemperature) - * [`RAParticleInletProperties.SetTonnage()`](RAParticleInletProperties.md#generated.RAParticleInletProperties.SetTonnage) * [RAParticleInletPropertiesList](RAParticleInletPropertiesList.md) * [`RAParticleInletPropertiesList`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList) * [`RAParticleInletPropertiesList.Clear()`](RAParticleInletPropertiesList.md#generated.RAParticleInletPropertiesList.Clear) @@ -2270,7 +2414,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleJointsData.GetCurveNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNames) * [`RAParticleJointsData.GetCurveNamesAssociation()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetCurveNamesAssociation) * [`RAParticleJointsData.GetElementCurve()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetElementCurve) + * [`RAParticleJointsData.GetFacePositions()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetFacePositions) + * [`RAParticleJointsData.GetFaceVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetFaceVertices) * [`RAParticleJointsData.GetGeometryQuantity()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryQuantity) + * [`RAParticleJointsData.GetGeometryTransform()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryTransform) * [`RAParticleJointsData.GetGeometryUnit()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGeometryUnit) * [`RAParticleJointsData.GetGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunction) * [`RAParticleJointsData.GetGridFunctionNames()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetGridFunctionNames) @@ -2283,6 +2430,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleJointsData.GetTimeStatistics()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStatistics) * [`RAParticleJointsData.GetTimeStep()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTimeStep) * [`RAParticleJointsData.GetTopologyShape()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetTopologyShape) + * [`RAParticleJointsData.GetVertices()`](RAParticleJointsData.md#generated.RAParticleJointsData.GetVertices) * [`RAParticleJointsData.HasGridFunction()`](RAParticleJointsData.md#generated.RAParticleJointsData.HasGridFunction) * [`RAParticleJointsData.IsCellActive()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCellActive) * [`RAParticleJointsData.IsCollectJointDataEnabled()`](RAParticleJointsData.md#generated.RAParticleJointsData.IsCollectJointDataEnabled) @@ -2322,7 +2470,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleTimeSelectionProcess.GetCurveNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNames) * [`RAParticleTimeSelectionProcess.GetCurveNamesAssociation()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetCurveNamesAssociation) * [`RAParticleTimeSelectionProcess.GetElementCurve()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetElementCurve) + * [`RAParticleTimeSelectionProcess.GetFacePositions()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetFacePositions) + * [`RAParticleTimeSelectionProcess.GetFaceVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetFaceVertices) * [`RAParticleTimeSelectionProcess.GetGeometryQuantity()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryQuantity) + * [`RAParticleTimeSelectionProcess.GetGeometryTransform()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryTransform) * [`RAParticleTimeSelectionProcess.GetGeometryUnit()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGeometryUnit) * [`RAParticleTimeSelectionProcess.GetGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunction) * [`RAParticleTimeSelectionProcess.GetGridFunctionNames()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetGridFunctionNames) @@ -2337,6 +2488,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleTimeSelectionProcess.GetTimeStatistics()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStatistics) * [`RAParticleTimeSelectionProcess.GetTimeStep()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTimeStep) * [`RAParticleTimeSelectionProcess.GetTopologyShape()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetTopologyShape) + * [`RAParticleTimeSelectionProcess.GetVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.GetVertices) * [`RAParticleTimeSelectionProcess.HasGridFunction()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.HasGridFunction) * [`RAParticleTimeSelectionProcess.IsCellActive()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IsCellActive) * [`RAParticleTimeSelectionProcess.IterCellVertices()`](RAParticleTimeSelectionProcess.md#generated.RAParticleTimeSelectionProcess.IterCellVertices) @@ -2377,7 +2529,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleToContactProcess.GetCurveNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNames) * [`RAParticleToContactProcess.GetCurveNamesAssociation()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetCurveNamesAssociation) * [`RAParticleToContactProcess.GetElementCurve()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetElementCurve) + * [`RAParticleToContactProcess.GetFacePositions()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetFacePositions) + * [`RAParticleToContactProcess.GetFaceVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetFaceVertices) * [`RAParticleToContactProcess.GetGeometryQuantity()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryQuantity) + * [`RAParticleToContactProcess.GetGeometryTransform()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryTransform) * [`RAParticleToContactProcess.GetGeometryUnit()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGeometryUnit) * [`RAParticleToContactProcess.GetGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunction) * [`RAParticleToContactProcess.GetGridFunctionNames()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetGridFunctionNames) @@ -2391,6 +2546,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticleToContactProcess.GetTimeStatistics()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStatistics) * [`RAParticleToContactProcess.GetTimeStep()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTimeStep) * [`RAParticleToContactProcess.GetTopologyShape()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetTopologyShape) + * [`RAParticleToContactProcess.GetVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.GetVertices) * [`RAParticleToContactProcess.HasGridFunction()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.HasGridFunction) * [`RAParticleToContactProcess.IsCellActive()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IsCellActive) * [`RAParticleToContactProcess.IterCellVertices()`](RAParticleToContactProcess.md#generated.RAParticleToContactProcess.IterCellVertices) @@ -2429,7 +2585,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticles.GetCurveNames()`](RAParticles.md#generated.RAParticles.GetCurveNames) * [`RAParticles.GetCurveNamesAssociation()`](RAParticles.md#generated.RAParticles.GetCurveNamesAssociation) * [`RAParticles.GetElementCurve()`](RAParticles.md#generated.RAParticles.GetElementCurve) + * [`RAParticles.GetFacePositions()`](RAParticles.md#generated.RAParticles.GetFacePositions) + * [`RAParticles.GetFaceVertices()`](RAParticles.md#generated.RAParticles.GetFaceVertices) * [`RAParticles.GetGeometryQuantity()`](RAParticles.md#generated.RAParticles.GetGeometryQuantity) + * [`RAParticles.GetGeometryTransform()`](RAParticles.md#generated.RAParticles.GetGeometryTransform) * [`RAParticles.GetGeometryUnit()`](RAParticles.md#generated.RAParticles.GetGeometryUnit) * [`RAParticles.GetGridFunction()`](RAParticles.md#generated.RAParticles.GetGridFunction) * [`RAParticles.GetGridFunctionNames()`](RAParticles.md#generated.RAParticles.GetGridFunctionNames) @@ -2443,6 +2602,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAParticles.GetTimeStatistics()`](RAParticles.md#generated.RAParticles.GetTimeStatistics) * [`RAParticles.GetTimeStep()`](RAParticles.md#generated.RAParticles.GetTimeStep) * [`RAParticles.GetTopologyShape()`](RAParticles.md#generated.RAParticles.GetTopologyShape) + * [`RAParticles.GetVertices()`](RAParticles.md#generated.RAParticles.GetVertices) * [`RAParticles.HasGridFunction()`](RAParticles.md#generated.RAParticles.HasGridFunction) * [`RAParticles.IsCellActive()`](RAParticles.md#generated.RAParticles.IsCellActive) * [`RAParticles.IterCellVertices()`](RAParticles.md#generated.RAParticles.IterCellVertices) @@ -2522,6 +2682,28 @@ These are the classes and methods available to the user when executing scripts: * [`RAPhysics.SetUpdateDistanceMultiplier()`](RAPhysics.md#generated.RAPhysics.SetUpdateDistanceMultiplier) * [`RAPhysics.SetUseRadlEtAl()`](RAPhysics.md#generated.RAPhysics.SetUseRadlEtAl) * [`RAPhysics.SetVolumeFractionLimit()`](RAPhysics.md#generated.RAPhysics.SetVolumeFractionLimit) +* [RAPlaneGroup](RAPlaneGroup.md) + * [`RAPlaneGroup`](RAPlaneGroup.md#generated.RAPlaneGroup) + * [`RAPlaneGroup.AddCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.AddCurve) + * [`RAPlaneGroup.GetCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetCurve) + * [`RAPlaneGroup.GetCurveNames()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetCurveNames) + * [`RAPlaneGroup.GetCurveNamesAssociation()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetCurveNamesAssociation) + * [`RAPlaneGroup.GetElementCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetElementCurve) + * [`RAPlaneGroup.GetMode()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetMode) + * [`RAPlaneGroup.GetNumpyCurve()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetNumpyCurve) + * [`RAPlaneGroup.GetOrientation()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientation) + * [`RAPlaneGroup.GetOrientationFromAngleAndVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientationFromAngleAndVector) + * [`RAPlaneGroup.GetOrientationFromAngles()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientationFromAngles) + * [`RAPlaneGroup.GetOrientationFromBasisVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrientationFromBasisVector) + * [`RAPlaneGroup.GetOrigin()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetOrigin) + * [`RAPlaneGroup.GetType()`](RAPlaneGroup.md#generated.RAPlaneGroup.GetType) + * [`RAPlaneGroup.SetMode()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetMode) + * [`RAPlaneGroup.SetOrientation()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientation) + * [`RAPlaneGroup.SetOrientationFromAngleAndVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientationFromAngleAndVector) + * [`RAPlaneGroup.SetOrientationFromAngles()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientationFromAngles) + * [`RAPlaneGroup.SetOrientationFromBasisVector()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrientationFromBasisVector) + * [`RAPlaneGroup.SetOrigin()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetOrigin) + * [`RAPlaneGroup.SetType()`](RAPlaneGroup.md#generated.RAPlaneGroup.SetType) * [RAPlaneProcess](RAPlaneProcess.md) * [`RAPlaneProcess`](RAPlaneProcess.md#generated.RAPlaneProcess) * [`RAPlaneProcess.AddCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.AddCurve) @@ -2549,13 +2731,15 @@ These are the classes and methods available to the user when executing scripts: * [`RAPlaneProcess.GetCurveNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNames) * [`RAPlaneProcess.GetCurveNamesAssociation()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetCurveNamesAssociation) * [`RAPlaneProcess.GetElementCurve()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetElementCurve) + * [`RAPlaneProcess.GetFacePositions()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetFacePositions) + * [`RAPlaneProcess.GetFaceVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetFaceVertices) * [`RAPlaneProcess.GetGeometryQuantity()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryQuantity) + * [`RAPlaneProcess.GetGeometryTransform()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryTransform) * [`RAPlaneProcess.GetGeometryUnit()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGeometryUnit) * [`RAPlaneProcess.GetGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGridFunction) * [`RAPlaneProcess.GetGridFunctionNames()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetGridFunctionNames) * [`RAPlaneProcess.GetMeshColoring()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetMeshColoring) * [`RAPlaneProcess.GetMode()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetMode) - * [`RAPlaneProcess.GetNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNormal) * [`RAPlaneProcess.GetNumberOfCells()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumberOfCells) * [`RAPlaneProcess.GetNumberOfNodes()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumberOfNodes) * [`RAPlaneProcess.GetNumberOfParticles()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetNumberOfParticles) @@ -2566,13 +2750,13 @@ These are the classes and methods available to the user when executing scripts: * [`RAPlaneProcess.GetOrientationFromBasisVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrientationFromBasisVector) * [`RAPlaneProcess.GetOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOrigin) * [`RAPlaneProcess.GetOutputVariableValue()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetOutputVariableValue) - * [`RAPlaneProcess.GetPlaneNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetPlaneNormal) - * [`RAPlaneProcess.GetPlaneOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetPlaneOrigin) + * [`RAPlaneProcess.GetRelativeRotationVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetRelativeRotationVector) * [`RAPlaneProcess.GetTimeSet()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTimeSet) * [`RAPlaneProcess.GetTimeStatistics()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTimeStatistics) * [`RAPlaneProcess.GetTimeStep()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTimeStep) * [`RAPlaneProcess.GetTopologyShape()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetTopologyShape) * [`RAPlaneProcess.GetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetType) + * [`RAPlaneProcess.GetVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.GetVertices) * [`RAPlaneProcess.HasGridFunction()`](RAPlaneProcess.md#generated.RAPlaneProcess.HasGridFunction) * [`RAPlaneProcess.IsCellActive()`](RAPlaneProcess.md#generated.RAPlaneProcess.IsCellActive) * [`RAPlaneProcess.IterCellVertices()`](RAPlaneProcess.md#generated.RAPlaneProcess.IterCellVertices) @@ -2585,14 +2769,12 @@ These are the classes and methods available to the user when executing scripts: * [`RAPlaneProcess.RemoveProcess()`](RAPlaneProcess.md#generated.RAPlaneProcess.RemoveProcess) * [`RAPlaneProcess.SetCurrentTimeStep()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetCurrentTimeStep) * [`RAPlaneProcess.SetMode()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetMode) - * [`RAPlaneProcess.SetNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetNormal) * [`RAPlaneProcess.SetOrientation()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientation) * [`RAPlaneProcess.SetOrientationFromAngleAndVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientationFromAngleAndVector) * [`RAPlaneProcess.SetOrientationFromAngles()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientationFromAngles) * [`RAPlaneProcess.SetOrientationFromBasisVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrientationFromBasisVector) * [`RAPlaneProcess.SetOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetOrigin) - * [`RAPlaneProcess.SetPlaneNormal()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetPlaneNormal) - * [`RAPlaneProcess.SetPlaneOrigin()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetPlaneOrigin) + * [`RAPlaneProcess.SetRelativeRotationVector()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetRelativeRotationVector) * [`RAPlaneProcess.SetType()`](RAPlaneProcess.md#generated.RAPlaneProcess.SetType) * [RAPointCloud](RAPointCloud.md) * [`RAPointCloud`](RAPointCloud.md#generated.RAPointCloud) @@ -2624,8 +2806,11 @@ These are the classes and methods available to the user when executing scripts: * [`RAPointCloud.GetCurveNamesAssociation()`](RAPointCloud.md#generated.RAPointCloud.GetCurveNamesAssociation) * [`RAPointCloud.GetElementCurve()`](RAPointCloud.md#generated.RAPointCloud.GetElementCurve) * [`RAPointCloud.GetEnablePeriodic()`](RAPointCloud.md#generated.RAPointCloud.GetEnablePeriodic) + * [`RAPointCloud.GetFacePositions()`](RAPointCloud.md#generated.RAPointCloud.GetFacePositions) + * [`RAPointCloud.GetFaceVertices()`](RAPointCloud.md#generated.RAPointCloud.GetFaceVertices) * [`RAPointCloud.GetFilePath()`](RAPointCloud.md#generated.RAPointCloud.GetFilePath) * [`RAPointCloud.GetGeometryQuantity()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryQuantity) + * [`RAPointCloud.GetGeometryTransform()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryTransform) * [`RAPointCloud.GetGeometryUnit()`](RAPointCloud.md#generated.RAPointCloud.GetGeometryUnit) * [`RAPointCloud.GetGridFunction()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunction) * [`RAPointCloud.GetGridFunctionNames()`](RAPointCloud.md#generated.RAPointCloud.GetGridFunctionNames) @@ -2640,11 +2825,13 @@ These are the classes and methods available to the user when executing scripts: * [`RAPointCloud.GetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStartTime) * [`RAPointCloud.GetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.GetPeriodicStopTime) * [`RAPointCloud.GetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOff) + * [`RAPointCloud.GetSearchCutOffDistance()`](RAPointCloud.md#generated.RAPointCloud.GetSearchCutOffDistance) * [`RAPointCloud.GetTimeSet()`](RAPointCloud.md#generated.RAPointCloud.GetTimeSet) * [`RAPointCloud.GetTimeStatistics()`](RAPointCloud.md#generated.RAPointCloud.GetTimeStatistics) * [`RAPointCloud.GetTimeStep()`](RAPointCloud.md#generated.RAPointCloud.GetTimeStep) * [`RAPointCloud.GetTopologyShape()`](RAPointCloud.md#generated.RAPointCloud.GetTopologyShape) * [`RAPointCloud.GetValidOptionsForModuleProperty()`](RAPointCloud.md#generated.RAPointCloud.GetValidOptionsForModuleProperty) + * [`RAPointCloud.GetVertices()`](RAPointCloud.md#generated.RAPointCloud.GetVertices) * [`RAPointCloud.HasGridFunction()`](RAPointCloud.md#generated.RAPointCloud.HasGridFunction) * [`RAPointCloud.IsCellActive()`](RAPointCloud.md#generated.RAPointCloud.IsCellActive) * [`RAPointCloud.IsPeriodicEnabled()`](RAPointCloud.md#generated.RAPointCloud.IsPeriodicEnabled) @@ -2664,6 +2851,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAPointCloud.SetPeriodicStartTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStartTime) * [`RAPointCloud.SetPeriodicStopTime()`](RAPointCloud.md#generated.RAPointCloud.SetPeriodicStopTime) * [`RAPointCloud.SetSearchCutOff()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOff) + * [`RAPointCloud.SetSearchCutOffDistance()`](RAPointCloud.md#generated.RAPointCloud.SetSearchCutOffDistance) * [RAPointCloudCollection](RAPointCloudCollection.md) * [`RAPointCloudCollection`](RAPointCloudCollection.md#generated.RAPointCloudCollection) * [`RAPointCloudCollection.Clear()`](RAPointCloudCollection.md#generated.RAPointCloudCollection.Clear) @@ -2698,7 +2886,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAPolyhedronProcess.GetCurveNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNames) * [`RAPolyhedronProcess.GetCurveNamesAssociation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetCurveNamesAssociation) * [`RAPolyhedronProcess.GetElementCurve()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetElementCurve) + * [`RAPolyhedronProcess.GetFacePositions()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetFacePositions) + * [`RAPolyhedronProcess.GetFaceVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetFaceVertices) * [`RAPolyhedronProcess.GetGeometryQuantity()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryQuantity) + * [`RAPolyhedronProcess.GetGeometryTransform()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryTransform) * [`RAPolyhedronProcess.GetGeometryUnit()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGeometryUnit) * [`RAPolyhedronProcess.GetGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunction) * [`RAPolyhedronProcess.GetGridFunctionNames()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetGridFunctionNames) @@ -2713,13 +2904,12 @@ These are the classes and methods available to the user when executing scripts: * [`RAPolyhedronProcess.GetOrientationFromAngles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromAngles) * [`RAPolyhedronProcess.GetOrientationFromBasisVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOrientationFromBasisVector) * [`RAPolyhedronProcess.GetOutputVariableValue()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetOutputVariableValue) - * [`RAPolyhedronProcess.GetRotation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetRotation) * [`RAPolyhedronProcess.GetScale()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetScale) - * [`RAPolyhedronProcess.GetSize()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetSize) * [`RAPolyhedronProcess.GetTimeSet()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTimeSet) * [`RAPolyhedronProcess.GetTimeStatistics()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTimeStatistics) * [`RAPolyhedronProcess.GetTimeStep()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTimeStep) * [`RAPolyhedronProcess.GetTopologyShape()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetTopologyShape) + * [`RAPolyhedronProcess.GetVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.GetVertices) * [`RAPolyhedronProcess.HasGridFunction()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.HasGridFunction) * [`RAPolyhedronProcess.IsCellActive()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IsCellActive) * [`RAPolyhedronProcess.IterCellVertices()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.IterCellVertices) @@ -2737,10 +2927,8 @@ These are the classes and methods available to the user when executing scripts: * [`RAPolyhedronProcess.SetOrientationFromAngleAndVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientationFromAngleAndVector) * [`RAPolyhedronProcess.SetOrientationFromAngles()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientationFromAngles) * [`RAPolyhedronProcess.SetOrientationFromBasisVector()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetOrientationFromBasisVector) - * [`RAPolyhedronProcess.SetRotation()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetRotation) * [`RAPolyhedronProcess.SetSTL()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetSTL) * [`RAPolyhedronProcess.SetScale()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetScale) - * [`RAPolyhedronProcess.SetSize()`](RAPolyhedronProcess.md#generated.RAPolyhedronProcess.SetSize) * [RAPrescribedForce](RAPrescribedForce.md) * [`RAPrescribedForce`](RAPrescribedForce.md#generated.RAPrescribedForce) * [`RAPrescribedForce.GetForceValue()`](RAPrescribedForce.md#generated.RAPrescribedForce.GetForceValue) @@ -2761,6 +2949,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAProject.GetStudy()`](RAProject.md#generated.RAProject.GetStudy) * [`RAProject.GetTimeFilter()`](RAProject.md#generated.RAProject.GetTimeFilter) * [`RAProject.GetUserProcessCollection()`](RAProject.md#generated.RAProject.GetUserProcessCollection) + * [`RAProject.HasUnsavedChanges()`](RAProject.md#generated.RAProject.HasUnsavedChanges) * [`RAProject.RemoveProcess()`](RAProject.md#generated.RAProject.RemoveProcess) * [`RAProject.SaveProject()`](RAProject.md#generated.RAProject.SaveProject) * [`RAProject.SaveProjectForRestart()`](RAProject.md#generated.RAProject.SaveProjectForRestart) @@ -2790,6 +2979,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAReceivingConveyor.GetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltThickness) * [`RAReceivingConveyor.GetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBeltWidth) * [`RAReceivingConveyor.GetBoundingBox()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetBoundingBox) + * [`RAReceivingConveyor.GetCapillaryFrictionCoefficient()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCapillaryFrictionCoefficient) * [`RAReceivingConveyor.GetCellAreaAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellAreaAsArray) * [`RAReceivingConveyor.GetCellCenterAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellCenterAsArray) * [`RAReceivingConveyor.GetCellDzAsArray()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCellDzAsArray) @@ -2803,7 +2993,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAReceivingConveyor.GetCurveNamesAssociation()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetCurveNamesAssociation) * [`RAReceivingConveyor.GetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetDecelerationPeriod) * [`RAReceivingConveyor.GetElementCurve()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetElementCurve) + * [`RAReceivingConveyor.GetFacePositions()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetFacePositions) + * [`RAReceivingConveyor.GetFaceVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetFaceVertices) * [`RAReceivingConveyor.GetGeometryQuantity()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryQuantity) + * [`RAReceivingConveyor.GetGeometryTransform()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryTransform) * [`RAReceivingConveyor.GetGeometryUnit()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGeometryUnit) * [`RAReceivingConveyor.GetGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunction) * [`RAReceivingConveyor.GetGridFunctionNames()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetGridFunctionNames) @@ -2837,6 +3030,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAReceivingConveyor.GetValidSphBoundaryTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidSphBoundaryTypeValues) * [`RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetValidThermalBoundaryConditionTypeValues) * [`RAReceivingConveyor.GetVerticalOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVerticalOffset) + * [`RAReceivingConveyor.GetVertices()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetVertices) * [`RAReceivingConveyor.GetWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.GetWidth) * [`RAReceivingConveyor.HasGridFunction()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.HasGridFunction) * [`RAReceivingConveyor.IsCellActive()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.IsCellActive) @@ -2856,6 +3050,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAReceivingConveyor.SetBeltSpeed()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltSpeed) * [`RAReceivingConveyor.SetBeltThickness()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltThickness) * [`RAReceivingConveyor.SetBeltWidth()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetBeltWidth) + * [`RAReceivingConveyor.SetCapillaryFrictionCoefficient()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCapillaryFrictionCoefficient) * [`RAReceivingConveyor.SetCurrentTimeStep()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetCurrentTimeStep) * [`RAReceivingConveyor.SetDecelerationPeriod()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetDecelerationPeriod) * [`RAReceivingConveyor.SetHeightOffset()`](RAReceivingConveyor.md#generated.RAReceivingConveyor.SetHeightOffset) @@ -2903,12 +3098,16 @@ These are the classes and methods available to the user when executing scripts: * [`RARectangularSurface.GetCurveNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNames) * [`RARectangularSurface.GetCurveNamesAssociation()`](RARectangularSurface.md#generated.RARectangularSurface.GetCurveNamesAssociation) * [`RARectangularSurface.GetElementCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetElementCurve) + * [`RARectangularSurface.GetFacePositions()`](RARectangularSurface.md#generated.RARectangularSurface.GetFacePositions) + * [`RARectangularSurface.GetFaceVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetFaceVertices) * [`RARectangularSurface.GetGeometryQuantity()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryQuantity) + * [`RARectangularSurface.GetGeometryTransform()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryTransform) * [`RARectangularSurface.GetGeometryUnit()`](RARectangularSurface.md#generated.RARectangularSurface.GetGeometryUnit) * [`RARectangularSurface.GetGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.GetGridFunction) * [`RARectangularSurface.GetGridFunctionNames()`](RARectangularSurface.md#generated.RARectangularSurface.GetGridFunctionNames) * [`RARectangularSurface.GetLength()`](RARectangularSurface.md#generated.RARectangularSurface.GetLength) * [`RARectangularSurface.GetMeshColoring()`](RARectangularSurface.md#generated.RARectangularSurface.GetMeshColoring) + * [`RARectangularSurface.GetMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.GetMotionFrame) * [`RARectangularSurface.GetNumberOfCells()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfCells) * [`RARectangularSurface.GetNumberOfNodes()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumberOfNodes) * [`RARectangularSurface.GetNumpyCurve()`](RARectangularSurface.md#generated.RARectangularSurface.GetNumpyCurve) @@ -2921,6 +3120,7 @@ These are the classes and methods available to the user when executing scripts: * [`RARectangularSurface.GetTimeStatistics()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStatistics) * [`RARectangularSurface.GetTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.GetTimeStep) * [`RARectangularSurface.GetTopologyShape()`](RARectangularSurface.md#generated.RARectangularSurface.GetTopologyShape) + * [`RARectangularSurface.GetVertices()`](RARectangularSurface.md#generated.RARectangularSurface.GetVertices) * [`RARectangularSurface.GetWidth()`](RARectangularSurface.md#generated.RARectangularSurface.GetWidth) * [`RARectangularSurface.HasGridFunction()`](RARectangularSurface.md#generated.RARectangularSurface.HasGridFunction) * [`RARectangularSurface.HasMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.HasMotionFrame) @@ -2935,6 +3135,7 @@ These are the classes and methods available to the user when executing scripts: * [`RARectangularSurface.SetCenter()`](RARectangularSurface.md#generated.RARectangularSurface.SetCenter) * [`RARectangularSurface.SetCurrentTimeStep()`](RARectangularSurface.md#generated.RARectangularSurface.SetCurrentTimeStep) * [`RARectangularSurface.SetLength()`](RARectangularSurface.md#generated.RARectangularSurface.SetLength) + * [`RARectangularSurface.SetMotionFrame()`](RARectangularSurface.md#generated.RARectangularSurface.SetMotionFrame) * [`RARectangularSurface.SetOrientation()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientation) * [`RARectangularSurface.SetOrientationFromAngleAndVector()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngleAndVector) * [`RARectangularSurface.SetOrientationFromAngles()`](RARectangularSurface.md#generated.RARectangularSurface.SetOrientationFromAngles) @@ -2969,7 +3170,10 @@ These are the classes and methods available to the user when executing scripts: * [`RARegionOfInterestCube.GetCurveNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNames) * [`RARegionOfInterestCube.GetCurveNamesAssociation()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetCurveNamesAssociation) * [`RARegionOfInterestCube.GetElementCurve()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetElementCurve) + * [`RARegionOfInterestCube.GetFacePositions()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetFacePositions) + * [`RARegionOfInterestCube.GetFaceVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetFaceVertices) * [`RARegionOfInterestCube.GetGeometryQuantity()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryQuantity) + * [`RARegionOfInterestCube.GetGeometryTransform()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryTransform) * [`RARegionOfInterestCube.GetGeometryUnit()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGeometryUnit) * [`RARegionOfInterestCube.GetGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunction) * [`RARegionOfInterestCube.GetGridFunctionNames()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetGridFunctionNames) @@ -2988,6 +3192,7 @@ These are the classes and methods available to the user when executing scripts: * [`RARegionOfInterestCube.GetTimeStatistics()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStatistics) * [`RARegionOfInterestCube.GetTimeStep()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTimeStep) * [`RARegionOfInterestCube.GetTopologyShape()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetTopologyShape) + * [`RARegionOfInterestCube.GetVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.GetVertices) * [`RARegionOfInterestCube.HasGridFunction()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.HasGridFunction) * [`RARegionOfInterestCube.IsCellActive()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IsCellActive) * [`RARegionOfInterestCube.IterCellVertices()`](RARegionOfInterestCube.md#generated.RARegionOfInterestCube.IterCellVertices) @@ -3034,8 +3239,11 @@ These are the classes and methods available to the user when executing scripts: * [`RARegionOfInterestCylinder.GetCurveNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNames) * [`RARegionOfInterestCylinder.GetCurveNamesAssociation()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetCurveNamesAssociation) * [`RARegionOfInterestCylinder.GetElementCurve()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetElementCurve) + * [`RARegionOfInterestCylinder.GetFacePositions()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFacePositions) + * [`RARegionOfInterestCylinder.GetFaceVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFaceVertices) * [`RARegionOfInterestCylinder.GetFinalAngle()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetFinalAngle) * [`RARegionOfInterestCylinder.GetGeometryQuantity()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryQuantity) + * [`RARegionOfInterestCylinder.GetGeometryTransform()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryTransform) * [`RARegionOfInterestCylinder.GetGeometryUnit()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGeometryUnit) * [`RARegionOfInterestCylinder.GetGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunction) * [`RARegionOfInterestCylinder.GetGridFunctionNames()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetGridFunctionNames) @@ -3057,6 +3265,7 @@ These are the classes and methods available to the user when executing scripts: * [`RARegionOfInterestCylinder.GetTimeStatistics()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStatistics) * [`RARegionOfInterestCylinder.GetTimeStep()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTimeStep) * [`RARegionOfInterestCylinder.GetTopologyShape()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetTopologyShape) + * [`RARegionOfInterestCylinder.GetVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.GetVertices) * [`RARegionOfInterestCylinder.HasGridFunction()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.HasGridFunction) * [`RARegionOfInterestCylinder.IsCellActive()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IsCellActive) * [`RARegionOfInterestCylinder.IterCellVertices()`](RARegionOfInterestCylinder.md#generated.RARegionOfInterestCylinder.IterCellVertices) @@ -3111,16 +3320,17 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.CreateGridFunctionStatisticOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateGridFunctionStatisticOutputVariable) * [`RASPHSettings.CreateTransientCurveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.CreateTransientCurveOutputVariable) * [`RASPHSettings.DisableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.DisableEulerianSolution) + * [`RASPHSettings.DisableRelaxedIncompressibilityConstraint()`](RASPHSettings.md#generated.RASPHSettings.DisableRelaxedIncompressibilityConstraint) * [`RASPHSettings.DisableShepardFilterOnDensity()`](RASPHSettings.md#generated.RASPHSettings.DisableShepardFilterOnDensity) * [`RASPHSettings.DisableShepardFilterOnPressure()`](RASPHSettings.md#generated.RASPHSettings.DisableShepardFilterOnPressure) * [`RASPHSettings.EditCustomCurve()`](RASPHSettings.md#generated.RASPHSettings.EditCustomCurve) * [`RASPHSettings.EditCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.EditCustomProperty) * [`RASPHSettings.EnableEulerianSolution()`](RASPHSettings.md#generated.RASPHSettings.EnableEulerianSolution) + * [`RASPHSettings.EnableRelaxedIncompressibilityConstraint()`](RASPHSettings.md#generated.RASPHSettings.EnableRelaxedIncompressibilityConstraint) * [`RASPHSettings.EnableShepardFilterOnDensity()`](RASPHSettings.md#generated.RASPHSettings.EnableShepardFilterOnDensity) * [`RASPHSettings.EnableShepardFilterOnPressure()`](RASPHSettings.md#generated.RASPHSettings.EnableShepardFilterOnPressure) * [`RASPHSettings.GetActivesArray()`](RASPHSettings.md#generated.RASPHSettings.GetActivesArray) * [`RASPHSettings.GetAvailableFluidMaterials()`](RASPHSettings.md#generated.RASPHSettings.GetAvailableFluidMaterials) - * [`RASPHSettings.GetBackgroundPressure()`](RASPHSettings.md#generated.RASPHSettings.GetBackgroundPressure) * [`RASPHSettings.GetBoundingBox()`](RASPHSettings.md#generated.RASPHSettings.GetBoundingBox) * [`RASPHSettings.GetCS()`](RASPHSettings.md#generated.RASPHSettings.GetCS) * [`RASPHSettings.GetCellAreaAsArray()`](RASPHSettings.md#generated.RASPHSettings.GetCellAreaAsArray) @@ -3142,13 +3352,18 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.GetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorNorm) * [`RASPHSettings.GetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.GetDistFactorTang) * [`RASPHSettings.GetElementCurve()`](RASPHSettings.md#generated.RASPHSettings.GetElementCurve) + * [`RASPHSettings.GetEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEnabled) * [`RASPHSettings.GetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetEulerianSolutionEnabled) + * [`RASPHSettings.GetFacePositions()`](RASPHSettings.md#generated.RASPHSettings.GetFacePositions) + * [`RASPHSettings.GetFaceVertices()`](RASPHSettings.md#generated.RASPHSettings.GetFaceVertices) * [`RASPHSettings.GetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.GetFluidMaterial) * [`RASPHSettings.GetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.GetFreeSurfaceDivergenceLimit) * [`RASPHSettings.GetGeometryQuantity()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryQuantity) + * [`RASPHSettings.GetGeometryTransform()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryTransform) * [`RASPHSettings.GetGeometryUnit()`](RASPHSettings.md#generated.RASPHSettings.GetGeometryUnit) * [`RASPHSettings.GetGridFunction()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunction) * [`RASPHSettings.GetGridFunctionNames()`](RASPHSettings.md#generated.RASPHSettings.GetGridFunctionNames) + * [`RASPHSettings.GetIncompressibilityRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetIncompressibilityRelaxationFactor) * [`RASPHSettings.GetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.GetKernelDistFactor) * [`RASPHSettings.GetKernelType()`](RASPHSettings.md#generated.RASPHSettings.GetKernelType) * [`RASPHSettings.GetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.GetLimitTurbulentViscosity) @@ -3166,6 +3381,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.GetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.GetPosCorrectionType) * [`RASPHSettings.GetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.GetPressureDeg) * [`RASPHSettings.GetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetPressureUnderRelaxationFactor) + * [`RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetRelaxedIncompressibilityConstraintEnabled) * [`RASPHSettings.GetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnDensityEnabled) * [`RASPHSettings.GetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.GetShepardFilterOnPressureEnabled) * [`RASPHSettings.GetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.GetShiftingFactor) @@ -3198,11 +3414,18 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.GetValidSurfaceTensionTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidSurfaceTensionTypeValues) * [`RASPHSettings.GetValidTurbulenceTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidTurbulenceTypeValues) * [`RASPHSettings.GetValidViscosityTypeValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscosityTypeValues) + * [`RASPHSettings.GetValidViscousForceIntegrationValues()`](RASPHSettings.md#generated.RASPHSettings.GetValidViscousForceIntegrationValues) + * [`RASPHSettings.GetVertices()`](RASPHSettings.md#generated.RASPHSettings.GetVertices) * [`RASPHSettings.GetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.GetViscosityType) + * [`RASPHSettings.GetViscousForceIntegration()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceIntegration) + * [`RASPHSettings.GetViscousForceMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceMaximumNumberOfIterations) + * [`RASPHSettings.GetViscousForceRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceRelativeErrorTolerance) + * [`RASPHSettings.GetViscousForceUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.GetViscousForceUnderRelaxationFactor) * [`RASPHSettings.GetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.GetXsphFactor) * [`RASPHSettings.HasGridFunction()`](RASPHSettings.md#generated.RASPHSettings.HasGridFunction) * [`RASPHSettings.IsCellActive()`](RASPHSettings.md#generated.RASPHSettings.IsCellActive) * [`RASPHSettings.IsEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsEulerianSolutionEnabled) + * [`RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsRelaxedIncompressibilityConstraintEnabled) * [`RASPHSettings.IsShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnDensityEnabled) * [`RASPHSettings.IsShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.IsShepardFilterOnPressureEnabled) * [`RASPHSettings.IterCellVertices()`](RASPHSettings.md#generated.RASPHSettings.IterCellVertices) @@ -3212,7 +3435,6 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.RemoveCustomProperty()`](RASPHSettings.md#generated.RASPHSettings.RemoveCustomProperty) * [`RASPHSettings.RemoveOutputVariable()`](RASPHSettings.md#generated.RASPHSettings.RemoveOutputVariable) * [`RASPHSettings.RemoveProcess()`](RASPHSettings.md#generated.RASPHSettings.RemoveProcess) - * [`RASPHSettings.SetBackgroundPressure()`](RASPHSettings.md#generated.RASPHSettings.SetBackgroundPressure) * [`RASPHSettings.SetCS()`](RASPHSettings.md#generated.RASPHSettings.SetCS) * [`RASPHSettings.SetClearyFactor()`](RASPHSettings.md#generated.RASPHSettings.SetClearyFactor) * [`RASPHSettings.SetCurrentTimeStep()`](RASPHSettings.md#generated.RASPHSettings.SetCurrentTimeStep) @@ -3222,9 +3444,11 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.SetDissFactor()`](RASPHSettings.md#generated.RASPHSettings.SetDissFactor) * [`RASPHSettings.SetDistFactorNorm()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorNorm) * [`RASPHSettings.SetDistFactorTang()`](RASPHSettings.md#generated.RASPHSettings.SetDistFactorTang) + * [`RASPHSettings.SetEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEnabled) * [`RASPHSettings.SetEulerianSolutionEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetEulerianSolutionEnabled) * [`RASPHSettings.SetFluidMaterial()`](RASPHSettings.md#generated.RASPHSettings.SetFluidMaterial) * [`RASPHSettings.SetFreeSurfaceDivergenceLimit()`](RASPHSettings.md#generated.RASPHSettings.SetFreeSurfaceDivergenceLimit) + * [`RASPHSettings.SetIncompressibilityRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetIncompressibilityRelaxationFactor) * [`RASPHSettings.SetKernelDistFactor()`](RASPHSettings.md#generated.RASPHSettings.SetKernelDistFactor) * [`RASPHSettings.SetKernelType()`](RASPHSettings.md#generated.RASPHSettings.SetKernelType) * [`RASPHSettings.SetLimitTurbulentViscosity()`](RASPHSettings.md#generated.RASPHSettings.SetLimitTurbulentViscosity) @@ -3237,6 +3461,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.SetPosCorrectionType()`](RASPHSettings.md#generated.RASPHSettings.SetPosCorrectionType) * [`RASPHSettings.SetPressureDeg()`](RASPHSettings.md#generated.RASPHSettings.SetPressureDeg) * [`RASPHSettings.SetPressureUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetPressureUnderRelaxationFactor) + * [`RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetRelaxedIncompressibilityConstraintEnabled) * [`RASPHSettings.SetShepardFilterOnDensityEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnDensityEnabled) * [`RASPHSettings.SetShepardFilterOnPressureEnabled()`](RASPHSettings.md#generated.RASPHSettings.SetShepardFilterOnPressureEnabled) * [`RASPHSettings.SetShiftingFactor()`](RASPHSettings.md#generated.RASPHSettings.SetShiftingFactor) @@ -3260,6 +3485,10 @@ These are the classes and methods available to the user when executing scripts: * [`RASPHSettings.SetUpdateCoupledDensity()`](RASPHSettings.md#generated.RASPHSettings.SetUpdateCoupledDensity) * [`RASPHSettings.SetUseParticlesNeighborsList()`](RASPHSettings.md#generated.RASPHSettings.SetUseParticlesNeighborsList) * [`RASPHSettings.SetViscosityType()`](RASPHSettings.md#generated.RASPHSettings.SetViscosityType) + * [`RASPHSettings.SetViscousForceIntegration()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceIntegration) + * [`RASPHSettings.SetViscousForceMaximumNumberOfIterations()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceMaximumNumberOfIterations) + * [`RASPHSettings.SetViscousForceRelativeErrorTolerance()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceRelativeErrorTolerance) + * [`RASPHSettings.SetViscousForceUnderRelaxationFactor()`](RASPHSettings.md#generated.RASPHSettings.SetViscousForceUnderRelaxationFactor) * [`RASPHSettings.SetXsphFactor()`](RASPHSettings.md#generated.RASPHSettings.SetXsphFactor) * [RASimulatorRun](RASimulatorRun.md) * [`RASimulatorRun`](RASimulatorRun.md#generated.RASimulatorRun) @@ -3308,7 +3537,6 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.GetCellNumberOfVertices()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellNumberOfVertices) * [`RASimulatorRun.GetCellPointsAsFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellPointsAsFunction) * [`RASimulatorRun.GetCellVolumeAsArray()`](RASimulatorRun.md#generated.RASimulatorRun.GetCellVolumeAsArray) - * [`RASimulatorRun.GetCollectForcesForFemAnalysis()`](RASimulatorRun.md#generated.RASimulatorRun.GetCollectForcesForFemAnalysis) * [`RASimulatorRun.GetContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.GetContactNeighboringDistanceBetweenParticles) * [`RASimulatorRun.GetContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.GetContactNeighboringDistanceBetweenParticlesAndTriangles) * [`RASimulatorRun.GetCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetCurve) @@ -3318,9 +3546,12 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetDisableTrianglesOnPeriodicBoundaries) * [`RASimulatorRun.GetDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetDragLimiterFactor) * [`RASimulatorRun.GetElementCurve()`](RASimulatorRun.md#generated.RASimulatorRun.GetElementCurve) + * [`RASimulatorRun.GetFacePositions()`](RASimulatorRun.md#generated.RASimulatorRun.GetFacePositions) + * [`RASimulatorRun.GetFaceVertices()`](RASimulatorRun.md#generated.RASimulatorRun.GetFaceVertices) * [`RASimulatorRun.GetFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetFixedTimestep) * [`RASimulatorRun.GetFluentOutputsMultiplier()`](RASimulatorRun.md#generated.RASimulatorRun.GetFluentOutputsMultiplier) * [`RASimulatorRun.GetGeometryQuantity()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryQuantity) + * [`RASimulatorRun.GetGeometryTransform()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryTransform) * [`RASimulatorRun.GetGeometryUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetGeometryUnit) * [`RASimulatorRun.GetGridFunction()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunction) * [`RASimulatorRun.GetGridFunctionNames()`](RASimulatorRun.md#generated.RASimulatorRun.GetGridFunctionNames) @@ -3334,6 +3565,12 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.GetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertiesData) * [`RASimulatorRun.GetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.GetModulesOutputPropertyEnabled) * [`RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.GetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.GetMpiHeterogeneous()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiHeterogeneous) + * [`RASimulatorRun.GetMpiHostfile()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiHostfile) + * [`RASimulatorRun.GetMpiHosts()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiHosts) + * [`RASimulatorRun.GetMpiNumberOfProcesses()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiNumberOfProcesses) + * [`RASimulatorRun.GetMpiNumberOfThreads()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiNumberOfThreads) + * [`RASimulatorRun.GetMpiWithinScheduler()`](RASimulatorRun.md#generated.RASimulatorRun.GetMpiWithinScheduler) * [`RASimulatorRun.GetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.GetMultiGpuSlicingDirection) * [`RASimulatorRun.GetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.GetNegateInitialOverlaps) * [`RASimulatorRun.GetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.GetNeighborSearchModel) @@ -3347,15 +3584,13 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.GetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverRelaxationCoefficient) * [`RASimulatorRun.GetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.GetOverlapParticlesDelay) * [`RASimulatorRun.GetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.GetParticleSizeLimitForReordering) + * [`RASimulatorRun.GetProcessingUnit()`](RASimulatorRun.md#generated.RASimulatorRun.GetProcessingUnit) * [`RASimulatorRun.GetRefineConcaveSearch()`](RASimulatorRun.md#generated.RASimulatorRun.GetRefineConcaveSearch) * [`RASimulatorRun.GetReleaseParticlesWithoutOverlapCheck()`](RASimulatorRun.md#generated.RASimulatorRun.GetReleaseParticlesWithoutOverlapCheck) * [`RASimulatorRun.GetResetOnlyPhysicalContactsData()`](RASimulatorRun.md#generated.RASimulatorRun.GetResetOnlyPhysicalContactsData) * [`RASimulatorRun.GetResumeDataFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetResumeDataFrequency) * [`RASimulatorRun.GetSimulationDuration()`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationDuration) - * [`RASimulatorRun.GetSimulationOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationOutputFrequency) - * [`RASimulatorRun.GetSimulationTarget()`](RASimulatorRun.md#generated.RASimulatorRun.GetSimulationTarget) * [`RASimulatorRun.GetSolverCurvesFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetSolverCurvesFrequency) - * [`RASimulatorRun.GetSolverCurvesOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetSolverCurvesOutputFrequency) * [`RASimulatorRun.GetSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetSortingDistanceFactor) * [`RASimulatorRun.GetSpecialReorderingForWidePsd()`](RASimulatorRun.md#generated.RASimulatorRun.GetSpecialReorderingForWidePsd) * [`RASimulatorRun.GetStandardOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.GetStandardOutputPropertiesData) @@ -3380,16 +3615,15 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDpmBlockingEffectForSinglePhaseSimulations) * [`RASimulatorRun.GetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseDragLimiterFactor) * [`RASimulatorRun.GetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseFixedTimestep) + * [`RASimulatorRun.GetUseMpi()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseMpi) * [`RASimulatorRun.GetUseNonRoundTorqueCorrection()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseNonRoundTorqueCorrection) * [`RASimulatorRun.GetUseSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.GetUseSortingDistanceFactor) * [`RASimulatorRun.GetValidDeformableMassMatrixTypeValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidDeformableMassMatrixTypeValues) * [`RASimulatorRun.GetValidMultiGpuSlicingDirectionValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidMultiGpuSlicingDirectionValues) * [`RASimulatorRun.GetValidNeighborSearchModelValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidNeighborSearchModelValues) - * [`RASimulatorRun.GetValidSimulationTargetValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidSimulationTargetValues) + * [`RASimulatorRun.GetValidProcessingUnitValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidProcessingUnitValues) * [`RASimulatorRun.GetValidTimestepModelValues()`](RASimulatorRun.md#generated.RASimulatorRun.GetValidTimestepModelValues) - * [`RASimulatorRun.GetWearEnergySpectraBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearEnergySpectraBreakageDelayAfterRelease) - * [`RASimulatorRun.GetWearEnergySpectraBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearEnergySpectraBreakageStart) - * [`RASimulatorRun.GetWearGeometryUpdateFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateFrequency) + * [`RASimulatorRun.GetVertices()`](RASimulatorRun.md#generated.RASimulatorRun.GetVertices) * [`RASimulatorRun.GetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearGeometryUpdateInterval) * [`RASimulatorRun.GetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.GetWearStart) * [`RASimulatorRun.HasFEMForcesEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.HasFEMForcesEnabled) @@ -3414,7 +3648,6 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.SetBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.SetBreakageDelayAfterRelease) * [`RASimulatorRun.SetBreakageOverlapFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetBreakageOverlapFactor) * [`RASimulatorRun.SetBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.SetBreakageStart) - * [`RASimulatorRun.SetCollectForcesForFemAnalysis()`](RASimulatorRun.md#generated.RASimulatorRun.SetCollectForcesForFemAnalysis) * [`RASimulatorRun.SetContactNeighboringDistanceBetweenParticles()`](RASimulatorRun.md#generated.RASimulatorRun.SetContactNeighboringDistanceBetweenParticles) * [`RASimulatorRun.SetContactNeighboringDistanceBetweenParticlesAndTriangles()`](RASimulatorRun.md#generated.RASimulatorRun.SetContactNeighboringDistanceBetweenParticlesAndTriangles) * [`RASimulatorRun.SetCurrentTimeStep()`](RASimulatorRun.md#generated.RASimulatorRun.SetCurrentTimeStep) @@ -3432,6 +3665,12 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.SetModulesOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertiesData) * [`RASimulatorRun.SetModulesOutputPropertyEnabled()`](RASimulatorRun.md#generated.RASimulatorRun.SetModulesOutputPropertyEnabled) * [`RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries()`](RASimulatorRun.md#generated.RASimulatorRun.SetMoveCfdCellsWithRockyBoundaries) + * [`RASimulatorRun.SetMpiHeterogeneous()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiHeterogeneous) + * [`RASimulatorRun.SetMpiHostfile()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiHostfile) + * [`RASimulatorRun.SetMpiHosts()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiHosts) + * [`RASimulatorRun.SetMpiNumberOfProcesses()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiNumberOfProcesses) + * [`RASimulatorRun.SetMpiNumberOfThreads()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiNumberOfThreads) + * [`RASimulatorRun.SetMpiWithinScheduler()`](RASimulatorRun.md#generated.RASimulatorRun.SetMpiWithinScheduler) * [`RASimulatorRun.SetMultiGpuSlicingDirection()`](RASimulatorRun.md#generated.RASimulatorRun.SetMultiGpuSlicingDirection) * [`RASimulatorRun.SetNegateInitialOverlaps()`](RASimulatorRun.md#generated.RASimulatorRun.SetNegateInitialOverlaps) * [`RASimulatorRun.SetNeighborSearchModel()`](RASimulatorRun.md#generated.RASimulatorRun.SetNeighborSearchModel) @@ -3441,15 +3680,13 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.SetOverRelaxationCoefficient()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverRelaxationCoefficient) * [`RASimulatorRun.SetOverlapParticlesDelay()`](RASimulatorRun.md#generated.RASimulatorRun.SetOverlapParticlesDelay) * [`RASimulatorRun.SetParticleSizeLimitForReordering()`](RASimulatorRun.md#generated.RASimulatorRun.SetParticleSizeLimitForReordering) + * [`RASimulatorRun.SetProcessingUnit()`](RASimulatorRun.md#generated.RASimulatorRun.SetProcessingUnit) * [`RASimulatorRun.SetRefineConcaveSearch()`](RASimulatorRun.md#generated.RASimulatorRun.SetRefineConcaveSearch) * [`RASimulatorRun.SetReleaseParticlesWithoutOverlapCheck()`](RASimulatorRun.md#generated.RASimulatorRun.SetReleaseParticlesWithoutOverlapCheck) * [`RASimulatorRun.SetResetOnlyPhysicalContactsData()`](RASimulatorRun.md#generated.RASimulatorRun.SetResetOnlyPhysicalContactsData) * [`RASimulatorRun.SetResumeDataFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetResumeDataFrequency) * [`RASimulatorRun.SetSimulationDuration()`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationDuration) - * [`RASimulatorRun.SetSimulationOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationOutputFrequency) - * [`RASimulatorRun.SetSimulationTarget()`](RASimulatorRun.md#generated.RASimulatorRun.SetSimulationTarget) * [`RASimulatorRun.SetSolverCurvesFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetSolverCurvesFrequency) - * [`RASimulatorRun.SetSolverCurvesOutputFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetSolverCurvesOutputFrequency) * [`RASimulatorRun.SetSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetSortingDistanceFactor) * [`RASimulatorRun.SetSpecialReorderingForWidePsd()`](RASimulatorRun.md#generated.RASimulatorRun.SetSpecialReorderingForWidePsd) * [`RASimulatorRun.SetStandardOutputPropertiesData()`](RASimulatorRun.md#generated.RASimulatorRun.SetStandardOutputPropertiesData) @@ -3471,11 +3708,9 @@ These are the classes and methods available to the user when executing scripts: * [`RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDpmBlockingEffectForSinglePhaseSimulations) * [`RASimulatorRun.SetUseDragLimiterFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseDragLimiterFactor) * [`RASimulatorRun.SetUseFixedTimestep()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseFixedTimestep) + * [`RASimulatorRun.SetUseMpi()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseMpi) * [`RASimulatorRun.SetUseNonRoundTorqueCorrection()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseNonRoundTorqueCorrection) * [`RASimulatorRun.SetUseSortingDistanceFactor()`](RASimulatorRun.md#generated.RASimulatorRun.SetUseSortingDistanceFactor) - * [`RASimulatorRun.SetWearEnergySpectraBreakageDelayAfterRelease()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearEnergySpectraBreakageDelayAfterRelease) - * [`RASimulatorRun.SetWearEnergySpectraBreakageStart()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearEnergySpectraBreakageStart) - * [`RASimulatorRun.SetWearGeometryUpdateFrequency()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearGeometryUpdateFrequency) * [`RASimulatorRun.SetWearGeometryUpdateInterval()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearGeometryUpdateInterval) * [`RASimulatorRun.SetWearStart()`](RASimulatorRun.md#generated.RASimulatorRun.SetWearStart) * [RASizeDistribution](RASizeDistribution.md) @@ -3567,7 +3802,10 @@ These are the classes and methods available to the user when executing scripts: * [`RAStreamlinesUserProcess.GetCurveNamesAssociation()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetCurveNamesAssociation) * [`RAStreamlinesUserProcess.GetDirection()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetDirection) * [`RAStreamlinesUserProcess.GetElementCurve()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetElementCurve) + * [`RAStreamlinesUserProcess.GetFacePositions()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetFacePositions) + * [`RAStreamlinesUserProcess.GetFaceVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetFaceVertices) * [`RAStreamlinesUserProcess.GetGeometryQuantity()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryQuantity) + * [`RAStreamlinesUserProcess.GetGeometryTransform()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryTransform) * [`RAStreamlinesUserProcess.GetGeometryUnit()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGeometryUnit) * [`RAStreamlinesUserProcess.GetGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunction) * [`RAStreamlinesUserProcess.GetGridFunctionNames()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetGridFunctionNames) @@ -3585,6 +3823,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAStreamlinesUserProcess.GetTimeStep()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTimeStep) * [`RAStreamlinesUserProcess.GetTopologyShape()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetTopologyShape) * [`RAStreamlinesUserProcess.GetValidDirectionValues()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetValidDirectionValues) + * [`RAStreamlinesUserProcess.GetVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.GetVertices) * [`RAStreamlinesUserProcess.HasGridFunction()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.HasGridFunction) * [`RAStreamlinesUserProcess.IsCellActive()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IsCellActive) * [`RAStreamlinesUserProcess.IterCellVertices()`](RAStreamlinesUserProcess.md#generated.RAStreamlinesUserProcess.IterCellVertices) @@ -3604,15 +3843,11 @@ These are the classes and methods available to the user when executing scripts: * [RAStudy](RAStudy.md) * [`RAStudy`](RAStudy.md#generated.RAStudy) * [`RAStudy.CanResumeSimulation()`](RAStudy.md#generated.RAStudy.CanResumeSimulation) - * [`RAStudy.CreateContinuousInjection()`](RAStudy.md#generated.RAStudy.CreateContinuousInjection) * [`RAStudy.CreateFeedConveyor()`](RAStudy.md#generated.RAStudy.CreateFeedConveyor) - * [`RAStudy.CreateInlet()`](RAStudy.md#generated.RAStudy.CreateInlet) - * [`RAStudy.CreateMaterialAndRelatedInteractions()`](RAStudy.md#generated.RAStudy.CreateMaterialAndRelatedInteractions) * [`RAStudy.CreateOutlet()`](RAStudy.md#generated.RAStudy.CreateOutlet) * [`RAStudy.CreateParticle()`](RAStudy.md#generated.RAStudy.CreateParticle) * [`RAStudy.CreateParticleInlet()`](RAStudy.md#generated.RAStudy.CreateParticleInlet) * [`RAStudy.CreateReceivingConveyor()`](RAStudy.md#generated.RAStudy.CreateReceivingConveyor) - * [`RAStudy.CreateVolumeFill()`](RAStudy.md#generated.RAStudy.CreateVolumeFill) * [`RAStudy.CreateVolumetricInlet()`](RAStudy.md#generated.RAStudy.CreateVolumetricInlet) * [`RAStudy.DeleteResults()`](RAStudy.md#generated.RAStudy.DeleteResults) * [`RAStudy.ExtendSimulation()`](RAStudy.md#generated.RAStudy.ExtendSimulation) @@ -3656,7 +3891,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAStudy.ImportWall()`](RAStudy.md#generated.RAStudy.ImportWall) * [`RAStudy.IsSimulating()`](RAStudy.md#generated.RAStudy.IsSimulating) * [`RAStudy.RefreshResults()`](RAStudy.md#generated.RAStudy.RefreshResults) - * [`RAStudy.RemoveMaterialAndRelatedInteractions()`](RAStudy.md#generated.RAStudy.RemoveMaterialAndRelatedInteractions) * [`RAStudy.RemoveSurface()`](RAStudy.md#generated.RAStudy.RemoveSurface) * [`RAStudy.RemoveWall()`](RAStudy.md#generated.RAStudy.RemoveWall) * [`RAStudy.ReplaceWallTriangles()`](RAStudy.md#generated.RAStudy.ReplaceWallTriangles) @@ -3697,12 +3931,16 @@ These are the classes and methods available to the user when executing scripts: * [`RASurface.GetCurveNames()`](RASurface.md#generated.RASurface.GetCurveNames) * [`RASurface.GetCurveNamesAssociation()`](RASurface.md#generated.RASurface.GetCurveNamesAssociation) * [`RASurface.GetElementCurve()`](RASurface.md#generated.RASurface.GetElementCurve) + * [`RASurface.GetFacePositions()`](RASurface.md#generated.RASurface.GetFacePositions) + * [`RASurface.GetFaceVertices()`](RASurface.md#generated.RASurface.GetFaceVertices) * [`RASurface.GetGeometryQuantity()`](RASurface.md#generated.RASurface.GetGeometryQuantity) + * [`RASurface.GetGeometryTransform()`](RASurface.md#generated.RASurface.GetGeometryTransform) * [`RASurface.GetGeometryUnit()`](RASurface.md#generated.RASurface.GetGeometryUnit) * [`RASurface.GetGridFunction()`](RASurface.md#generated.RASurface.GetGridFunction) * [`RASurface.GetGridFunctionNames()`](RASurface.md#generated.RASurface.GetGridFunctionNames) * [`RASurface.GetInvertNormal()`](RASurface.md#generated.RASurface.GetInvertNormal) * [`RASurface.GetMeshColoring()`](RASurface.md#generated.RASurface.GetMeshColoring) + * [`RASurface.GetMotionFrame()`](RASurface.md#generated.RASurface.GetMotionFrame) * [`RASurface.GetNumberOfCells()`](RASurface.md#generated.RASurface.GetNumberOfCells) * [`RASurface.GetNumberOfNodes()`](RASurface.md#generated.RASurface.GetNumberOfNodes) * [`RASurface.GetNumpyCurve()`](RASurface.md#generated.RASurface.GetNumpyCurve) @@ -3717,6 +3955,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASurface.GetTimeStep()`](RASurface.md#generated.RASurface.GetTimeStep) * [`RASurface.GetTopologyShape()`](RASurface.md#generated.RASurface.GetTopologyShape) * [`RASurface.GetTranslation()`](RASurface.md#generated.RASurface.GetTranslation) + * [`RASurface.GetVertices()`](RASurface.md#generated.RASurface.GetVertices) * [`RASurface.HasGridFunction()`](RASurface.md#generated.RASurface.HasGridFunction) * [`RASurface.HasMotionFrame()`](RASurface.md#generated.RASurface.HasMotionFrame) * [`RASurface.IsCellActive()`](RASurface.md#generated.RASurface.IsCellActive) @@ -3729,6 +3968,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASurface.RemoveProcess()`](RASurface.md#generated.RASurface.RemoveProcess) * [`RASurface.SetCurrentTimeStep()`](RASurface.md#generated.RASurface.SetCurrentTimeStep) * [`RASurface.SetInvertNormal()`](RASurface.md#generated.RASurface.SetInvertNormal) + * [`RASurface.SetMotionFrame()`](RASurface.md#generated.RASurface.SetMotionFrame) * [`RASurface.SetOrientation()`](RASurface.md#generated.RASurface.SetOrientation) * [`RASurface.SetOrientationFromAngleAndVector()`](RASurface.md#generated.RASurface.SetOrientationFromAngleAndVector) * [`RASurface.SetOrientationFromAngles()`](RASurface.md#generated.RASurface.SetOrientationFromAngles) @@ -3763,7 +4003,10 @@ These are the classes and methods available to the user when executing scripts: * [`RASurfaceUserProcess.GetCurveNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNames) * [`RASurfaceUserProcess.GetCurveNamesAssociation()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetCurveNamesAssociation) * [`RASurfaceUserProcess.GetElementCurve()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetElementCurve) + * [`RASurfaceUserProcess.GetFacePositions()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetFacePositions) + * [`RASurfaceUserProcess.GetFaceVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetFaceVertices) * [`RASurfaceUserProcess.GetGeometryQuantity()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryQuantity) + * [`RASurfaceUserProcess.GetGeometryTransform()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryTransform) * [`RASurfaceUserProcess.GetGeometryUnit()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGeometryUnit) * [`RASurfaceUserProcess.GetGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunction) * [`RASurfaceUserProcess.GetGridFunctionNames()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetGridFunctionNames) @@ -3783,6 +4026,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASurfaceUserProcess.GetTimeStatistics()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStatistics) * [`RASurfaceUserProcess.GetTimeStep()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTimeStep) * [`RASurfaceUserProcess.GetTopologyShape()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetTopologyShape) + * [`RASurfaceUserProcess.GetVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.GetVertices) * [`RASurfaceUserProcess.HasGridFunction()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.HasGridFunction) * [`RASurfaceUserProcess.IsCellActive()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IsCellActive) * [`RASurfaceUserProcess.IterCellVertices()`](RASurfaceUserProcess.md#generated.RASurfaceUserProcess.IterCellVertices) @@ -3822,6 +4066,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASystemCouplingWall.GetActivesArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetActivesArray) * [`RASystemCouplingWall.GetAvailableMaterials()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetAvailableMaterials) * [`RASystemCouplingWall.GetBoundingBox()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetBoundingBox) + * [`RASystemCouplingWall.GetCapillaryFrictionCoefficient()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCapillaryFrictionCoefficient) * [`RASystemCouplingWall.GetCellAreaAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellAreaAsArray) * [`RASystemCouplingWall.GetCellCenterAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellCenterAsArray) * [`RASystemCouplingWall.GetCellDzAsArray()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCellDzAsArray) @@ -3834,7 +4079,10 @@ These are the classes and methods available to the user when executing scripts: * [`RASystemCouplingWall.GetCurveNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNames) * [`RASystemCouplingWall.GetCurveNamesAssociation()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetCurveNamesAssociation) * [`RASystemCouplingWall.GetElementCurve()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetElementCurve) + * [`RASystemCouplingWall.GetFacePositions()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetFacePositions) + * [`RASystemCouplingWall.GetFaceVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetFaceVertices) * [`RASystemCouplingWall.GetGeometryQuantity()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryQuantity) + * [`RASystemCouplingWall.GetGeometryTransform()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryTransform) * [`RASystemCouplingWall.GetGeometryUnit()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGeometryUnit) * [`RASystemCouplingWall.GetGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunction) * [`RASystemCouplingWall.GetGridFunctionNames()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetGridFunctionNames) @@ -3855,6 +4103,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASystemCouplingWall.GetTopologyShape()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTopologyShape) * [`RASystemCouplingWall.GetTriangleSize()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetTriangleSize) * [`RASystemCouplingWall.GetValidSphBoundaryTypeValues()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetValidSphBoundaryTypeValues) + * [`RASystemCouplingWall.GetVertices()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.GetVertices) * [`RASystemCouplingWall.HasGridFunction()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasGridFunction) * [`RASystemCouplingWall.HasMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.HasMotionFrame) * [`RASystemCouplingWall.IsCellActive()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.IsCellActive) @@ -3867,6 +4116,7 @@ These are the classes and methods available to the user when executing scripts: * [`RASystemCouplingWall.RemoveCustomProperty()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveCustomProperty) * [`RASystemCouplingWall.RemoveOutputVariable()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveOutputVariable) * [`RASystemCouplingWall.RemoveProcess()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.RemoveProcess) + * [`RASystemCouplingWall.SetCapillaryFrictionCoefficient()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCapillaryFrictionCoefficient) * [`RASystemCouplingWall.SetCurrentTimeStep()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetCurrentTimeStep) * [`RASystemCouplingWall.SetMaterial()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMaterial) * [`RASystemCouplingWall.SetMotionFrame()`](RASystemCouplingWall.md#generated.RASystemCouplingWall.SetMotionFrame) @@ -3899,6 +4149,39 @@ These are the classes and methods available to the user when executing scripts: * [`RAThreeRollsBeltProfile.SetMaterial()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetMaterial) * [`RAThreeRollsBeltProfile.SetTroughingAngle()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetTroughingAngle) * [`RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths()`](RAThreeRollsBeltProfile.md#generated.RAThreeRollsBeltProfile.SetUse0371RatioForRollLengths) +* [RATimePlotWindow](RATimePlotWindow.md) + * [`RATimePlotWindow`](RATimePlotWindow.md#generated.RATimePlotWindow) + * [`RATimePlotWindow.ClearCurves()`](RATimePlotWindow.md#generated.RATimePlotWindow.ClearCurves) + * [`RATimePlotWindow.CloseWindow()`](RATimePlotWindow.md#generated.RATimePlotWindow.CloseWindow) + * [`RATimePlotWindow.CreateMark()`](RATimePlotWindow.md#generated.RATimePlotWindow.CreateMark) + * [`RATimePlotWindow.CreateTimeMark()`](RATimePlotWindow.md#generated.RATimePlotWindow.CreateTimeMark) + * [`RATimePlotWindow.ExportCurves()`](RATimePlotWindow.md#generated.RATimePlotWindow.ExportCurves) + * [`RATimePlotWindow.GetAxisLimits()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetAxisLimits) + * [`RATimePlotWindow.GetAxisUnit()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetAxisUnit) + * [`RATimePlotWindow.GetCurvesDescription()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetCurvesDescription) + * [`RATimePlotWindow.GetTable()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetTable) + * [`RATimePlotWindow.GetTimeStep()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetTimeStep) + * [`RATimePlotWindow.GetTitle()`](RATimePlotWindow.md#generated.RATimePlotWindow.GetTitle) + * [`RATimePlotWindow.InvalidateWindow()`](RATimePlotWindow.md#generated.RATimePlotWindow.InvalidateWindow) + * [`RATimePlotWindow.Resize()`](RATimePlotWindow.md#generated.RATimePlotWindow.Resize) + * [`RATimePlotWindow.SetAxisByProperty()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisByProperty) + * [`RATimePlotWindow.SetAxisByQuantity()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisByQuantity) + * [`RATimePlotWindow.SetAxisLimits()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisLimits) + * [`RATimePlotWindow.SetAxisUnit()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetAxisUnit) + * [`RATimePlotWindow.SetBottomAxisUnit()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetBottomAxisUnit) + * [`RATimePlotWindow.SetColoringStrategyByElement()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetColoringStrategyByElement) + * [`RATimePlotWindow.SetColoringStrategyByProperty()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetColoringStrategyByProperty) + * [`RATimePlotWindow.SetColoringStrategyByStudy()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetColoringStrategyByStudy) + * [`RATimePlotWindow.SetCurrentTimeStep()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetCurrentTimeStep) + * [`RATimePlotWindow.SetSelectedWindow()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetSelectedWindow) + * [`RATimePlotWindow.SetStickEnabled()`](RATimePlotWindow.md#generated.RATimePlotWindow.SetStickEnabled) + * [`RATimePlotWindow.ShowCurve()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowCurve) + * [`RATimePlotWindow.ShowGridFunctionStatisticsCurve()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowGridFunctionStatisticsCurve) + * [`RATimePlotWindow.ShowMaximized()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowMaximized) + * [`RATimePlotWindow.ShowMinimized()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowMinimized) + * [`RATimePlotWindow.ShowNormal()`](RATimePlotWindow.md#generated.RATimePlotWindow.ShowNormal) + * [`RATimePlotWindow.Snapshot()`](RATimePlotWindow.md#generated.RATimePlotWindow.Snapshot) + * [`RATimePlotWindow.app`](RATimePlotWindow.md#generated.RATimePlotWindow.app) * [RATimeRangeFilter](RATimeRangeFilter.md) * [`RATimeRangeFilter`](RATimeRangeFilter.md#generated.RATimeRangeFilter) * [`RATimeRangeFilter.GetDomainRange()`](RATimeRangeFilter.md#generated.RATimeRangeFilter.GetDomainRange) @@ -3941,7 +4224,10 @@ These are the classes and methods available to the user when executing scripts: * [`RATrajectoryProcess.GetCurveNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNames) * [`RATrajectoryProcess.GetCurveNamesAssociation()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetCurveNamesAssociation) * [`RATrajectoryProcess.GetElementCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetElementCurve) + * [`RATrajectoryProcess.GetFacePositions()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetFacePositions) + * [`RATrajectoryProcess.GetFaceVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetFaceVertices) * [`RATrajectoryProcess.GetGeometryQuantity()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryQuantity) + * [`RATrajectoryProcess.GetGeometryTransform()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryTransform) * [`RATrajectoryProcess.GetGeometryUnit()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGeometryUnit) * [`RATrajectoryProcess.GetGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunction) * [`RATrajectoryProcess.GetGridFunctionNames()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetGridFunctionNames) @@ -3950,16 +4236,15 @@ These are the classes and methods available to the user when executing scripts: * [`RATrajectoryProcess.GetNumberOfIntervals()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfIntervals) * [`RATrajectoryProcess.GetNumberOfNodes()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfNodes) * [`RATrajectoryProcess.GetNumberOfParticles()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfParticles) - * [`RATrajectoryProcess.GetNumberOfTimeSteps()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumberOfTimeSteps) * [`RATrajectoryProcess.GetNumpyCurve()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetNumpyCurve) * [`RATrajectoryProcess.GetOutputVariableValue()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetOutputVariableValue) * [`RATrajectoryProcess.GetParticleStride()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetParticleStride) * [`RATrajectoryProcess.GetStartingTime()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetStartingTime) - * [`RATrajectoryProcess.GetStartingTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetStartingTimeStep) * [`RATrajectoryProcess.GetTimeSet()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTimeSet) * [`RATrajectoryProcess.GetTimeStatistics()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTimeStatistics) * [`RATrajectoryProcess.GetTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTimeStep) * [`RATrajectoryProcess.GetTopologyShape()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetTopologyShape) + * [`RATrajectoryProcess.GetVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.GetVertices) * [`RATrajectoryProcess.HasGridFunction()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.HasGridFunction) * [`RATrajectoryProcess.IsCellActive()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IsCellActive) * [`RATrajectoryProcess.IterCellVertices()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.IterCellVertices) @@ -3972,10 +4257,8 @@ These are the classes and methods available to the user when executing scripts: * [`RATrajectoryProcess.RemoveProcess()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.RemoveProcess) * [`RATrajectoryProcess.SetCurrentTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetCurrentTimeStep) * [`RATrajectoryProcess.SetNumberOfIntervals()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetNumberOfIntervals) - * [`RATrajectoryProcess.SetNumberOfTimeSteps()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetNumberOfTimeSteps) * [`RATrajectoryProcess.SetParticleStride()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetParticleStride) * [`RATrajectoryProcess.SetStartingTime()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetStartingTime) - * [`RATrajectoryProcess.SetStartingTimeStep()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.SetStartingTimeStep) * [`RATrajectoryProcess.UpdateParticlesSelection()`](RATrajectoryProcess.md#generated.RATrajectoryProcess.UpdateParticlesSelection) * [RATranslation](RATranslation.md) * [`RATranslation`](RATranslation.md#generated.RATranslation) @@ -4045,8 +4328,11 @@ These are the classes and methods available to the user when executing scripts: * [`RAVibration.SetInitialPhase()`](RAVibration.md#generated.RAVibration.SetInitialPhase) * [RAVolumetricInlet](RAVolumetricInlet.md) * [`RAVolumetricInlet`](RAVolumetricInlet.md#generated.RAVolumetricInlet) + * [`RAVolumetricInlet.AddParticle()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.AddParticle) * [`RAVolumetricInlet.DisablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisablePeriodic) + * [`RAVolumetricInlet.DisableUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.DisableUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.EnablePeriodic()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnablePeriodic) + * [`RAVolumetricInlet.EnableUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.EnableUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.GetAvailableGeometries()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetAvailableGeometries) * [`RAVolumetricInlet.GetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxCenter) * [`RAVolumetricInlet.GetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetBoxDimensions) @@ -4065,8 +4351,11 @@ These are the classes and methods available to the user when executing scripts: * [`RAVolumetricInlet.GetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphMass) * [`RAVolumetricInlet.GetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetSphTemperature) * [`RAVolumetricInlet.GetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetStopTime) + * [`RAVolumetricInlet.GetUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.GetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.GetUseGeometriesToCompute) * [`RAVolumetricInlet.IsPeriodicEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsPeriodicEnabled) + * [`RAVolumetricInlet.IsUseBoxCenterAsSeedPointEnabled()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.IsUseBoxCenterAsSeedPointEnabled) + * [`RAVolumetricInlet.RemoveParticle()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.RemoveParticle) * [`RAVolumetricInlet.SetBoxCenter()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxCenter) * [`RAVolumetricInlet.SetBoxDimensions()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetBoxDimensions) * [`RAVolumetricInlet.SetGapScaleFactor()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetGapScaleFactor) @@ -4083,6 +4372,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAVolumetricInlet.SetSphMass()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphMass) * [`RAVolumetricInlet.SetSphTemperature()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetSphTemperature) * [`RAVolumetricInlet.SetStopTime()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetStopTime) + * [`RAVolumetricInlet.SetUseBoxCenterAsSeedPoint()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseBoxCenterAsSeedPoint) * [`RAVolumetricInlet.SetUseGeometriesToCompute()`](RAVolumetricInlet.md#generated.RAVolumetricInlet.SetUseGeometriesToCompute) * [RAVolumetricInletProperties](RAVolumetricInletProperties.md) * [`RAVolumetricInletProperties`](RAVolumetricInletProperties.md#generated.RAVolumetricInletProperties) @@ -4119,6 +4409,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.GetAvailableMaterials()`](RAWall.md#generated.RAWall.GetAvailableMaterials) * [`RAWall.GetBoundaryMass()`](RAWall.md#generated.RAWall.GetBoundaryMass) * [`RAWall.GetBoundingBox()`](RAWall.md#generated.RAWall.GetBoundingBox) + * [`RAWall.GetCapillaryFrictionCoefficient()`](RAWall.md#generated.RAWall.GetCapillaryFrictionCoefficient) * [`RAWall.GetCellAreaAsArray()`](RAWall.md#generated.RAWall.GetCellAreaAsArray) * [`RAWall.GetCellCenterAsArray()`](RAWall.md#generated.RAWall.GetCellCenterAsArray) * [`RAWall.GetCellDzAsArray()`](RAWall.md#generated.RAWall.GetCellDzAsArray) @@ -4133,12 +4424,14 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.GetDisableTime()`](RAWall.md#generated.RAWall.GetDisableTime) * [`RAWall.GetElementCurve()`](RAWall.md#generated.RAWall.GetElementCurve) * [`RAWall.GetEnableTime()`](RAWall.md#generated.RAWall.GetEnableTime) + * [`RAWall.GetFacePositions()`](RAWall.md#generated.RAWall.GetFacePositions) + * [`RAWall.GetFaceVertices()`](RAWall.md#generated.RAWall.GetFaceVertices) * [`RAWall.GetGeometryQuantity()`](RAWall.md#generated.RAWall.GetGeometryQuantity) + * [`RAWall.GetGeometryTransform()`](RAWall.md#generated.RAWall.GetGeometryTransform) * [`RAWall.GetGeometryUnit()`](RAWall.md#generated.RAWall.GetGeometryUnit) * [`RAWall.GetGravityCenter()`](RAWall.md#generated.RAWall.GetGravityCenter) * [`RAWall.GetGridFunction()`](RAWall.md#generated.RAWall.GetGridFunction) * [`RAWall.GetGridFunctionNames()`](RAWall.md#generated.RAWall.GetGridFunctionNames) - * [`RAWall.GetHorizontalOffset()`](RAWall.md#generated.RAWall.GetHorizontalOffset) * [`RAWall.GetMaterial()`](RAWall.md#generated.RAWall.GetMaterial) * [`RAWall.GetMeshColoring()`](RAWall.md#generated.RAWall.GetMeshColoring) * [`RAWall.GetModuleProperties()`](RAWall.md#generated.RAWall.GetModuleProperties) @@ -4146,6 +4439,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.GetMomentXDirection()`](RAWall.md#generated.RAWall.GetMomentXDirection) * [`RAWall.GetMomentYDirection()`](RAWall.md#generated.RAWall.GetMomentYDirection) * [`RAWall.GetMomentZDirection()`](RAWall.md#generated.RAWall.GetMomentZDirection) + * [`RAWall.GetMotionFrame()`](RAWall.md#generated.RAWall.GetMotionFrame) * [`RAWall.GetNumberOfCells()`](RAWall.md#generated.RAWall.GetNumberOfCells) * [`RAWall.GetNumberOfNodes()`](RAWall.md#generated.RAWall.GetNumberOfNodes) * [`RAWall.GetNumberOfReplications()`](RAWall.md#generated.RAWall.GetNumberOfReplications) @@ -4154,7 +4448,6 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.GetOrientationFromAngleAndVector()`](RAWall.md#generated.RAWall.GetOrientationFromAngleAndVector) * [`RAWall.GetOrientationFromAngles()`](RAWall.md#generated.RAWall.GetOrientationFromAngles) * [`RAWall.GetOrientationFromBasisVector()`](RAWall.md#generated.RAWall.GetOrientationFromBasisVector) - * [`RAWall.GetOutOfPlaneOffset()`](RAWall.md#generated.RAWall.GetOutOfPlaneOffset) * [`RAWall.GetOutputVariableValue()`](RAWall.md#generated.RAWall.GetOutputVariableValue) * [`RAWall.GetPeriodicReplication()`](RAWall.md#generated.RAWall.GetPeriodicReplication) * [`RAWall.GetPivotPoint()`](RAWall.md#generated.RAWall.GetPivotPoint) @@ -4175,7 +4468,7 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.GetValidSphBoundaryTypeValues()`](RAWall.md#generated.RAWall.GetValidSphBoundaryTypeValues) * [`RAWall.GetValidThermalBoundaryConditionTypeValues()`](RAWall.md#generated.RAWall.GetValidThermalBoundaryConditionTypeValues) * [`RAWall.GetValidWearModelValues()`](RAWall.md#generated.RAWall.GetValidWearModelValues) - * [`RAWall.GetVerticalOffset()`](RAWall.md#generated.RAWall.GetVerticalOffset) + * [`RAWall.GetVertices()`](RAWall.md#generated.RAWall.GetVertices) * [`RAWall.GetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.GetVolumeShearWorkRatio) * [`RAWall.GetWearModel()`](RAWall.md#generated.RAWall.GetWearModel) * [`RAWall.HasGridFunction()`](RAWall.md#generated.RAWall.HasGridFunction) @@ -4191,22 +4484,22 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.RemoveOutputVariable()`](RAWall.md#generated.RAWall.RemoveOutputVariable) * [`RAWall.RemoveProcess()`](RAWall.md#generated.RAWall.RemoveProcess) * [`RAWall.SetBoundaryMass()`](RAWall.md#generated.RAWall.SetBoundaryMass) + * [`RAWall.SetCapillaryFrictionCoefficient()`](RAWall.md#generated.RAWall.SetCapillaryFrictionCoefficient) * [`RAWall.SetCurrentTimeStep()`](RAWall.md#generated.RAWall.SetCurrentTimeStep) * [`RAWall.SetDisableTime()`](RAWall.md#generated.RAWall.SetDisableTime) * [`RAWall.SetEnableTime()`](RAWall.md#generated.RAWall.SetEnableTime) * [`RAWall.SetGravityCenter()`](RAWall.md#generated.RAWall.SetGravityCenter) - * [`RAWall.SetHorizontalOffset()`](RAWall.md#generated.RAWall.SetHorizontalOffset) * [`RAWall.SetMaterial()`](RAWall.md#generated.RAWall.SetMaterial) * [`RAWall.SetModuleProperty()`](RAWall.md#generated.RAWall.SetModuleProperty) * [`RAWall.SetMomentXDirection()`](RAWall.md#generated.RAWall.SetMomentXDirection) * [`RAWall.SetMomentYDirection()`](RAWall.md#generated.RAWall.SetMomentYDirection) * [`RAWall.SetMomentZDirection()`](RAWall.md#generated.RAWall.SetMomentZDirection) + * [`RAWall.SetMotionFrame()`](RAWall.md#generated.RAWall.SetMotionFrame) * [`RAWall.SetNumberOfReplications()`](RAWall.md#generated.RAWall.SetNumberOfReplications) * [`RAWall.SetOrientation()`](RAWall.md#generated.RAWall.SetOrientation) * [`RAWall.SetOrientationFromAngleAndVector()`](RAWall.md#generated.RAWall.SetOrientationFromAngleAndVector) * [`RAWall.SetOrientationFromAngles()`](RAWall.md#generated.RAWall.SetOrientationFromAngles) * [`RAWall.SetOrientationFromBasisVector()`](RAWall.md#generated.RAWall.SetOrientationFromBasisVector) - * [`RAWall.SetOutOfPlaneOffset()`](RAWall.md#generated.RAWall.SetOutOfPlaneOffset) * [`RAWall.SetPeriodicReplication()`](RAWall.md#generated.RAWall.SetPeriodicReplication) * [`RAWall.SetPivotPoint()`](RAWall.md#generated.RAWall.SetPivotPoint) * [`RAWall.SetPrincipalMomentOfInertia()`](RAWall.md#generated.RAWall.SetPrincipalMomentOfInertia) @@ -4218,7 +4511,5 @@ These are the classes and methods available to the user when executing scripts: * [`RAWall.SetThermalBoundaryConditionType()`](RAWall.md#generated.RAWall.SetThermalBoundaryConditionType) * [`RAWall.SetTranslation()`](RAWall.md#generated.RAWall.SetTranslation) * [`RAWall.SetTriangleSize()`](RAWall.md#generated.RAWall.SetTriangleSize) - * [`RAWall.SetUseWear()`](RAWall.md#generated.RAWall.SetUseWear) - * [`RAWall.SetVerticalOffset()`](RAWall.md#generated.RAWall.SetVerticalOffset) * [`RAWall.SetVolumeShearWorkRatio()`](RAWall.md#generated.RAWall.SetVolumeShearWorkRatio) * [`RAWall.SetWearModel()`](RAWall.md#generated.RAWall.SetWearModel)